python / python/cpython

Standardize os result dataclass documentation

Abierto
#151,684 1 comentario 1 reacción 1 asignado Ver en GitHub

@cmaloney ya está trabajando en esto.

Desde el 18/6/2026.

docs
Lenguaje dominante
Python
Estrellas
77.2k
Forks
35.9k
Métricas de merge de PR
Métricas de PR pendientes

Descripción

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

Guía de contribución

Abrir la guía de contribución

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Evaluación

Este issue todavía no se ha evaluado.

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.