Sphinx: Improve doc strings
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 55/100
- Issue type
- Documentation
- Clarity
- Clearly specified
- Activity status
- Stale
- Tech stack
- python
- Domain
- documentation
Research direction
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.
Written by the indexing model from the issue text.
Description
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.
- Dominant language
- Python
- Stars
- 34
- Forks
- 8
- PR merge metrics
- No merged PRs in 30d
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from klieret/RandomFileTree
-
Difficulty 1/5 Under an hour Newbie friendliness 78/100
klieret/RandomFileTree#102 ·
-
documentation
Difficulty 2/5 1-3 hours Newbie friendliness 35/100
klieret/RandomFileTree#36 ·
-
Difficulty 4/5 3-5 days Newbie friendliness 35/100
klieret/RandomFileTree#26 · 3 comments ·
-
allow to fix seed Opengood first issue hacktoberfest
Difficulty 4/5 3-5 days Newbie friendliness 45/100
-
Files with content Open
Difficulty 5/5 Over a week Newbie friendliness 30/100
klieret/RandomFileTree#2 · 5 comments ·
All issues in klieret/RandomFileTree
Similar issues
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 90/100
learningequality/ricecooker#747 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
BSData/horus-heresy-3rd-edition#3171 ·
-
enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
run-llama/llama_index#23199 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
KhronosGroup/glTF-Blender-IO#2769 ·