python / python/cpython

Standardize os result dataclass documentation

オープン
#151,684 コメント 1 件 リアクション 1 件 担当者 1 名 GitHub で見る

@cmaloney がすでに取り組んでいます。

2026年6月18日 から。

docs
主要言語
Python
スター
77.2k
フォーク
35.9k
PR マージ指標
PR 指標を取得中

説明

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

コントリビューションガイド

コントリビューションガイドを開く

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

評価

この issue はまだ評価されていません。

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。