Add a tool to count and report the missing docstrings
まだ誰も着手していません。
評価
- 難易度
- 5/5
- 見積もり時間
- 1週間以上
- 初心者へのやさしさ
- 30/100
- issue の種類
- 機能追加
- 明瞭さ
- おおむね明確
- 活発さ
- 停滞
- 技術スタック
- python
- 領域
- documentation, tooling
調査の方向性
まず既存の Element と GDScriptClass の実装を確認し、ドキュメント情報をどのように報告できるかを判断します。次に、新しいモジュールの入力とロギングの責務を定義します。ドキュメントの進捗と不足している docstring を示すテーブルを生成できれば完了です。
索引モデルが issue の本文から書いたものです。
説明
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.
- 主要言語
- Python
- スター
- 297
- フォーク
- 26
- PR マージ指標
- 30日以内にマージされた PR はありません
コントリビューションガイド
このリポジトリのコントリビューションガイドは索引されていません
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
GDQuest/gdscript-docs-maker のほかの issue
-
難易度 3/5 1〜2日 初心者へのやさしさ 38/100
GDQuest/gdscript-docs-maker#95 · コメント 4 件 · リアクション 1 件 ·
-
難易度 2/5 1〜3時間 初心者へのやさしさ 45/100
-
enhancement
難易度 4/5 3〜5日 初心者へのやさしさ 35/100
-
enhancement
難易度 2/5 1〜3時間 初心者へのやさしさ 55/100
GDQuest/gdscript-docs-maker#86 · リアクション 1 件 ·
-
bug
難易度 3/5 1〜2日 初心者へのやさしさ 35/100
GDQuest/gdscript-docs-maker#71 · コメント 3 件 ·
GDQuest/gdscript-docs-maker の issue をすべて見る
似ている issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
-
難易度 2/5 1〜3時間 初心者へのやさしさ 86/100
browser-use/browser-use#5905 ·
-
type: enhancement
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
ynput/ayon-python-api#363 ·
-
bug needs triage
難易度 2/5 1〜3時間 初心者へのやさしさ 88/100
modelscope/FunASR#3728 ·
-
難易度 2/5 1〜3時間 初心者へのやさしさ 88/100
open-compass/opencompass#2655 ·