Make docstrings to be nice with pydoc
Nadie ha tomado este issue todavía.
- Lenguaje dominante
- Python
- Estrellas
- 1.7k
- Forks
- 408
- Merge medio
- 2 d 57 min
- PR fusionados (30 d)
- 7
Descripción
In some doc-strings we use formatting rules specific to Sphinx, but which make the interactive help (pydoc) to look bad.
This issue is about:
- defining how we should write some recurrent stuff, like documenting input parameters and return values.
- rewrite the doc-strings so they look fine on pydoc, even if that means losing some features with Sphinx, like cross references.
Note. If we had the resources, we would do like Python does, and document things twice: once in the doc-strings and a feature rich version in the rst files. But in any case the doc-strings must be usable with pydoc, so lets start with that.
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
No se nombran archivos, pruebas ni puntos de entrada. Empieza por inventariar los docstrings del proyecto y comparar su salida renderizada en pydoc con las convenciones de Sphinx; se considera terminado cuando haya reglas de formato acordadas para los parámetros y valores de retorno recurrentes, además de docstrings reescritos que sigan siendo utilizables en pydoc.
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
- 5/5
- Tiempo estimado
- Más de una semana
- Estado de actividad
- Estancado
- Claridad
- Bastante claro
- Aptitud para principiantes
- 25/100