Sphinx: Improve doc strings
まだ誰も着手していません。
評価
- 難易度
- 2/5
- 見積もり時間
- 1〜3時間
- 初心者へのやさしさ
- 55/100
- issue の種類
- ドキュメント
- 明瞭さ
- 明確に書かれている
- 活発さ
- 停滞
- 技術スタック
- python
調査の方向性
Start with the docstring in randomfiletree/core.py at lines 114-134 and compare it with the rendered Sphinx output linked in the issue. Check why the arguments are not all recognized, and consider the work complete when the generated HTML documents every argument consistently with the original docstring.
索引モデルが issue の本文から書いたものです。
説明
I'm not a Sphinx fan so I'm not able to give you an advice how to solve this.
But please see that this HTML output
https://randomfiletree.readthedocs.io/en/latest/core.html#randomfiletree.core.iterative_gaussian_tree
doesn't fit to the original docstring
https://github.com/klieret/RandomFileTree/blob/4e3df78b642f46a7148661362d8e28935c72867f/randomfiletree/core.py#L114-L134
Not all arguments are recognized as arguments.
- 主要言語
- Python
- スター
- 34
- フォーク
- 8
- PR マージ指標
- 30日以内にマージされた PR はありません
コントリビューションガイド
このリポジトリのコントリビューションガイドは索引されていません
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
klieret/RandomFileTree のほかの issue
-
難易度 1/5 1時間未満 初心者へのやさしさ 78/100
klieret/RandomFileTree#102 ·
-
documentation
難易度 2/5 1〜3時間 初心者へのやさしさ 35/100
klieret/RandomFileTree#36 ·
-
難易度 4/5 3〜5日 初心者へのやさしさ 35/100
klieret/RandomFileTree#26 · コメント 3 件 ·
-
allow to fix seed オープンgood first issue hacktoberfest
難易度 4/5 3〜5日 初心者へのやさしさ 45/100
-
Files with content オープン
難易度 5/5 1週間以上 初心者へのやさしさ 30/100
klieret/RandomFileTree#2 · コメント 5 件 ·
klieret/RandomFileTree の issue をすべて見る
似ている issue
-
triage/confirmed
難易度 2/5 1〜3時間 初心者へのやさしさ 88/100
agentscope-ai/agentscope#2775 ·
-
comp/desktop P3 type/bug
難易度 1/5 1時間未満 初心者へのやさしさ 92/100
NousResearch/hermes-agent#118866 ·
-
bug
難易度 1/5 1時間未満 初心者へのやさしさ 90/100
apache/cloudstack#14222 ·
-
難易度 2/5 1〜3時間 初心者へのやさしさ 76/100
-
bug
難易度 2/5 1〜3時間 初心者へのやさしさ 82/100