Skip to content

Standardize os result dataclass documentation #151684

@cmaloney

Description

@cmaloney

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 #151301 (review)

Metadata

Metadata

Assignees

Labels

docsDocumentation in the Doc dir
No fields configured for issues without a type.

Projects

Status
Todo

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions