Standardize os result dataclass documentation
Open
@cmaloney is already working on this.
Since Jun 18, 2026.
docs
- Dominant language
- Python
- Stars
- 77.2k
- Forks
- 35.9k
- PR merge metrics
- PR metrics pending
Description
Documentation
- Document
times_resultandwaitid_resultwith members explicitly. Note the returned module name varies depending on environment (Ex.nt.times_resultvs.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
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Assessment
This issue has not been assessed yet.