python / python/cpython

Standardize os result dataclass documentation

Offen
#151,684 1 Kommentar 1 Reaktion 1 zugewiesene Person Auf GitHub ansehen

@cmaloney arbeitet bereits daran.

Seit 18.6.2026.

docs
Vorherrschende Sprache
Python
Sterne
77.2k
Forks
35.9k
PR-Merge-Kennzahlen
PR-Kennzahlen ausstehend

Beschreibung

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

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Bewertung

Dieses Issue wurde noch nicht bewertet.

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.