Sphinx: Improve doc strings
还没有人认领这个 Issue。
评估
- 难度
- 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 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 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 条评论 ·
-
good first issue hacktoberfest
难度 4/5 3-5 天 新手友好度 45/100
-
难度 5/5 一周以上 新手友好度 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