Sphinx: Improve doc strings

Abierto
#29 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
2/5
Tiempo estimado
1-3 horas
Aptitud para principiantes
55/100
Tipo de issue
Documentación
Claridad
Bien especificado
Estado de actividad
Estancado
Stack tecnológico
python
Área
documentation

Línea de trabajo

Start with the docstring in randomfiletree/core.py at lines 114-134 and compare it with the rendered Sphinx output linked in the issue. Check why the arguments are not all recognized, and consider the work complete when the generated HTML documents every argument consistently with the original docstring.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

documentation good first issue hacktoberfest

I'm not a Sphinx fan so I'm not able to give you an advice how to solve this.

But please see that this HTML output
https://randomfiletree.readthedocs.io/en/latest/core.html#randomfiletree.core.iterative_gaussian_tree

doesn't fit to the original docstring
https://github.com/klieret/RandomFileTree/blob/4e3df78b642f46a7148661362d8e28935c72867f/randomfiletree/core.py#L114-L134

Not all arguments are recognized as arguments.

Lenguaje dominante
Python
Estrellas
34
Forks
8
Sin PR fusionados en 30 d

Guía de contribución

No hay ninguna guía de contribución indexada para este repositorio

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.

Más de klieret/RandomFileTree

Todos los issues de klieret/RandomFileTree

Issues similares

Más issues de Python

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.