subprocess module docs contain an inconsistent mix of repeated versionchanged descriptions
Nadie ha tomado este issue todavía.
- Lenguaje dominante
- Python
- Estrellas
- 77.2k
- Forks
- 36k
- Merge medio
- 1 d 9 h
- PR fusionados (30 d)
- 558
Descripción
Documentation
The subprocess module documentation has an explosion of repeated text in versionchanged or versionadded markers splattered over multiple APIs within the docs.
The reality is that many of these are technically all directly Popen API changes, that the other higher level preferred more user friendly APIs like run() and call() and check_call() and check_output() all make use of internally and forward a majority of their arguments to.
Examples to look for: where are cwd, input, text, encoding, errors argument behavior changes/additions mentioned vs which APIs accept these.
I noticed this when looking over the changes made in https://github.com/python/cpython/issues/101283 where it became apparent to me that we're not internally consistent in how we do this within the doc today. The doc needs some cleanup and a strategy for this.
Guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Línea de trabajo
Empieza revisando la documentación del módulo subprocess y el issue 101283; después, compara las notas versionchanged y versionadded para Popen, run(), call(), check_call() y check_output(). Comprueba cómo se documentan cwd, input, text, encoding y errors en estas APIs. Se considera terminado cuando las notas siguen una estrategia coherente sin descripciones repetidas ni contradictorias.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- python
- Área
- documentation
- Tipo de issue
- Documentación
- Dificultad
- 4/5
- Tiempo estimado
- 3-5 días
- Estado de actividad
- Estancado
- Claridad
- Bastante claro
- Aptitud para principiantes
- 38/100