Address API documentation summary line TODOs
まだ誰も着手していません。
評価
- 難易度
- 4/5
- 見積もり時間
- 3〜5日
- 初心者へのやさしさ
- 45/100
- issue の種類
- ドキュメント
- 明瞭さ
- おおむね明確
- 活発さ
- 停滞
- 技術スタック
- python
調査の方向性
cf/ ディレクトリで git grep '\"\"\"TODO' | wc -l を実行して、要約 docstring がないメソッドを特定するところから始めます。Field.get_coordinate_reference を含む対象の各メソッドを読み、その基本的な目的と使用方法を理解します。TODO docstring に簡潔な要約行があり、残りの件数に対応できれば完了です。
索引モデルが issue の本文から書いたものです。
説明
All methods should at least have a summary line to outline their basic purpose or usage. Currently this is not the case leaving the rationale for methods such as Field.get_coordinate_reference (as noted in #239) potentially unclear.
As a crude estimate of the number of methods undocumented minimally, git grep '"""TODO' | wc -l under the cf/ dir gives 99 for the state of the codebase at time of making this comment (with the equivalent for "'''TODO" not required as black enforces double-quote marks for docstrings etc.). So ~100 methods need summarising. That's small enough to tackle for the next release, easily.
- 主要言語
- Python
- スター
- 150
- フォーク
- 23
- 平均マージ
- 1日 11時間
- マージ済み PR（30日）
- 2
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
NCAS-CMS/cf-python のほかの issue
-
code tidy
難易度 2/5 1〜3時間 初心者へのやさしさ 76/100
-
bug?
-
release
-
enhancement
-
bug
難易度 3/5 1〜2日 初心者へのやさしさ 45/100
NCAS-CMS/cf-python の issue をすべて見る
似ている issue
-
area/auth bug comp/agent P3 platform/discord type/security
難易度 2/5 1〜3時間 初心者へのやさしさ 88/100
NousResearch/hermes-agent#117848 ·
-
難易度 2/5 1〜3時間 初心者へのやさしさ 74/100
bancolombia/sentinel#23 ·
-
test md オープンCI
難易度 2/5 1〜3時間 初心者へのやさしさ 74/100
-
integration:quickjs org:external priority:backlog topic:code-interpreter topic:middleware type:feature
難易度 2/5 1〜3時間 初心者へのやさしさ 74/100
langchain-ai/deepagents#6450 ·
-
bug client
難易度 2/5 1〜3時間 初心者へのやさしさ 88/100