Add a tool to count and report the missing docstrings

Abierto

#54 abierto el 2/3/2020 0 comentarios 1 reacción 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad: 5/5
Tiempo estimado: Más de una semana
Aptitud para principiantes: 30/100

Tipo de issue: Nueva funcionalidad
Claridad: Bastante claro
Estado de actividad: Estancado
Stack tecnológico: python
Área: documentation, tooling

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.

Descripción

enhancement

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.

Lenguaje dominante: Python
Estrellas: 297
Forks: 26
Métricas de merge de PR: 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

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.

Más de GDQuest/gdscript-docs-maker

KeyError: 'name' while generating markdown files Abierto

Dificultad 3/5 1-2 días Aptitud para principiantes 38/100

GDQuest/gdscript-docs-maker#95 · 4 comentarios · 1 reacción · Abierto el 15/1/2024
Running gdscript_docs_maker.__main__ on reference.json Abierto

Dificultad 2/5 1-3 horas Aptitud para principiantes 45/100

GDQuest/gdscript-docs-maker#94 · Abierto el 20/12/2023
Replicate folder structure option for generate-ref script Abierto

enhancement

Dificultad 4/5 3-5 días Aptitud para principiantes 35/100

GDQuest/gdscript-docs-maker#87 · Abierto el 8/7/2021
Display errors of scripts in terminal Abierto

enhancement

Dificultad 2/5 1-3 horas Aptitud para principiantes 55/100

GDQuest/gdscript-docs-maker#86 · 1 reacción · Abierto el 8/7/2021
index is being generated blank Abierto

bug

Dificultad 3/5 1-2 días Aptitud para principiantes 35/100

GDQuest/gdscript-docs-maker#71 · 3 comentarios · Abierto el 30/11/2020

Todos los issues de GDQuest/gdscript-docs-maker

Issues similares

validate-structure inspecte challenge/work/.terraform et rend faux les labs qui ont un provider en cache Abierto

bug

Dificultad 2/5 1-3 horas Aptitud para principiantes 75/100

stephrobert/dsoxlab#238 · Abierto el 24/9/2026
Uniform probability densities use the upper bound as an interval width Abierto

Dificultad 2/5 1-3 horas Aptitud para principiantes 75/100

nasa/fmdtools#40 · Abierto el 24/9/2026
_common_folder() treats a single file as the common folder; single-file archives can't be installed (4.2.8) / crash (master) Abierto

Dificultad 2/5 1-3 horas Aptitud para principiantes 75/100

sublimehq/package_control#1780 · Abierto el 24/9/2026
Set 'Sample' input in 'autorun.py' to utilize 'Sample' Tab in eLog Abierto

Dificultad 2/5 1-3 horas Aptitud para principiantes 65/100

pcdshub/mfx#309 · 2 comentarios · Abierto el 24/9/2026
niri config file addition does not respect existing optional include Abierto

Dificultad 2/5 1-3 horas Aptitud para principiantes 70/100

nwg-piotr/nwg-displays#145 · Abierto el 24/9/2026

Más issues de Python