Make docstrings compatible with Read the Docs formatting
Open
Nobody has claimed this yet.
documentation
high desirability
- Dominant language
- Python
- Stars
- 255
- Forks
- 38
- Avg merge
- 11h 19m
- Merged PRs (30d)
- 9
Description
qldpc technically has a documentation page, but all docstrings were written to be readable in a text/code editor. Docstrings should be rewritten to be readable on Read the Docs.
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.
Research direction
Review the Python source docstrings and compare the existing documentation page on Read the Docs with how those docstrings render there. Identify the docstrings that need formatting changes, then confirm that the generated documentation is readable on Read the Docs across the affected API pages.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100