idekerlab / idekerlab/cellmaps_utils
Update documentation for `music_utils.py` to work with autodoc in sphinx
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 1
- Forks
- 1
- PR merge metrics
- No merged PRs in 30d
Description
refactor the documentation for music_utils.py to match docstring expected by autodoc and sphinx. Currently the documentation is just showing as raw text as one line as seen in this screenshot (run make docs to see in browser):
Note how the documentation is more readable for cellmaps_utils.cellmaps_utilscmd module and just plain text under cellmaps_utils.music_utils module
Contributor guide
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
Start with the documentation in music_utils.py and run make docs to reproduce the raw one-line rendering in the browser. Compare it with the readable cellmaps_utils.cellmaps_utilscmd module documentation. Done means the music_utils module documentation is formatted for autodoc and renders readably in Sphinx.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 55/100