python / python/cpython

Documentation for `PYTHONUNBUFFERED` is not correct

Đang mở
#128,392 4 bình luận 0 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

docs
Ngôn ngữ chính
Python
Star
77.2k
Fork
35.9k
Chỉ số merge pull request
Chỉ số pull request đang chờ

Mô tả

Documentation

Follow up on: https://github.com/python/cpython/issues/128377

According to docs, PYTHONUNBUFFERED is true if set as a non-empty string. Setting it to "0" (which is non-empty string) has effect of disabling it though.
Related C code:
https://github.com/python/cpython/blob/d903b17499b1a3bfb3ea848f6a1b6da02eac3328/Python/initconfig.c#L1786-L1790
https://github.com/python/cpython/blob/d903b17499b1a3bfb3ea848f6a1b6da02eac3328/Python/preconfig.c#L563-L578
https://github.com/python/cpython/blob/d903b17499b1a3bfb3ea848f6a1b6da02eac3328/Python/preconfig.c#L545-L560

We should probably rephrase it from:
If this is set to a non-empty string...
to:
If this is set...

Linked PRs
  • gh-128393

Hướng dẫn đóng góp

Mở hướng dẫn đóng góp

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Hướng nghiên cứu

Mở mục PYTHONUNBUFFERED trong tài liệu về các biến môi trường dòng lệnh của Python và so sánh cách diễn đạt của mục này với logic được trích dẫn trong Python/initconfig.c và Python/preconfig.c. Cập nhật phần mô tả để phản ánh chính xác hành vi được tài liệu hóa, sau đó kiểm tra lại cách diễn đạt trong tài liệu sau khi cập nhật; lưu ý rằng PR được liên kết gh-128393 cho biết công việc đã được tiến hành.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Đánh giá

Công nghệ
python
Lĩnh vực
documentation
Loại issue
Tài liệu
Độ khó
1/5
Thời gian dự kiến
Dưới một giờ
Mức độ hoạt động
Đình trệ
Độ rõ ràng
Đặc tả rõ ràng
Mức phù hợp với người mới
25/100

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.