GDQuest / GDQuest/gdscript-docs-maker
Add a tool to count and report the missing docstrings
- Vorherrschende Sprache
- Python
- Sterne
- 297
- Forks
- 26
- PR-Merge-Kennzahlen
- Keine gemergten PRs in 30 T.
Beschreibung
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.
Beitragsleitfaden
Für dieses Repository ist kein Beitragsleitfaden indexiert
Rechercherichtung
Beginne mit der Überprüfung der bestehenden Implementierungen von Element und GDScriptClass, um zu bestimmen, wie Dokumentationsinformationen gemeldet werden können. Definiere anschließend die Eingabe- und Protokollierungsverantwortlichkeiten des neuen Moduls; als abgeschlossen gilt die Aufgabe, wenn es eine Tabelle erzeugt, die den Dokumentationsfortschritt und fehlende Docstrings zeigt.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- python
- Bereich
- documentation, tooling
- Issue-Typ
- Feature
- Schwierigkeit
- 5/5
- Geschätzter Aufwand
- Über eine Woche
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 30/100