python / python/cpython

Standardize os result dataclass documentation

Đang mở
#151,684 1 bình luận 1 reaction 1 người được giao Xem trên GitHub

@cmaloney đang làm issue này rồi.

Từ ngày 18/6/2026.

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
  • Document times_result and waitid_result with members explicitly. Note the returned module name varies depending on environment (Ex. nt.times_result vs. posix.times_result)
  • Between class definition and flag sentences add a sentence referring back to the function that uses the flags (ex. os.wait* + os.WCONTINUED, os.preadv + os.RWF_HIPRI)
  • For each dataclass like type ensure there are references to the functions which can produce it.

Spotted by @serhiy-storchaka in https://github.com/python/cpython/pull/151301#pullrequestreview-4492900491

Linked PRs
  • gh-157132

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.

Đánh giá

Issue này chưa được đánh giá.

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.