TheAlgorithms / TheAlgorithms/Python
Suggestion: adopt a documentation format for docstring
Nadie ha tomado este issue todavía.
- Lenguaje dominante
- Python
- Estrellas
- 225k
- Forks
- 51.1k
- Merge medio
- 1 d 23 h
- PR fusionados (30 d)
- 156
Descripción
As the number of algorithms are increasing, it might make sense to adopt a single documentation format for docstrings. Following are existing currently:
- Google Docstring: https://google.github.io/styleguide/pyguide.html#s3.8-comments-and-docstrings
- Numpydoc: https://numpydoc.readthedocs.io/en/latest/format.html
- Sphinx: https://sphinx-rtd-tutorial.readthedocs.io/en/latest/docstrings.html
There are editor extensions which help in generating the docstring based on the chosen format like:
The doctest will come under the examples section for each of the above format.
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 comparando los formatos Google Docstring, Numpydoc y Sphinx enlazados en el issue, incluida la forma en que cada uno gestiona los ejemplos de doctest. Revisa la discusión para determinar si el proyecto ha elegido un formato. Se considera completado cuando existe un formato de documentación acordado y una forma definida de aplicarlo a los docstrings de los algoritmos.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- python
- Área
- documentation
- Tipo de issue
- Nueva funcionalidad
- Dificultad
- 5/5
- Tiempo estimado
- Más de una semana
- Estado de actividad
- Activo
- Claridad
- Necesita aclaración
- Aptitud para principiantes
- 25/100