GDQuest / GDQuest/gdscript-docs-maker
Add a tool to count and report the missing docstrings
- Lenguaje dominante
- Python
- Estrellas
- 297
- Forks
- 26
- Métricas de merge de PR
- Sin PR fusionados en 30 d
Descripción
We could have a tool similar to Godot's doctool, that gives a table with the docs progress and missing docstrings.
We can add methods on `Element` and `GDScriptClass` to report that information easily. Then, a new module should take care of reading and logging that information.
Guía de contribución
No hay ninguna guía de contribución indexada para este repositorio
Línea de trabajo
Comienza revisando las implementaciones existentes de Element y GDScriptClass para determinar cómo se puede informar de la información de documentación. Después, define las responsabilidades de entrada y registro del nuevo módulo; se considera terminado cuando produce una tabla que muestra el progreso de la documentación y los docstrings que faltan.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- python
- Área
- documentation, tooling
- Tipo de issue
- Nueva funcionalidad
- Dificultad
- 5/5
- Tiempo estimado
- Más de una semana
- Estado de actividad
- Estancado
- Claridad
- Bastante claro
- Aptitud para principiantes
- 30/100