Review how code and other types of formatting is used in docstrings
Open
@O957 is already working on this.
Since Jul 8, 2024.
clean up
documentation
- Dominant language
- Python
- Stars
- 29
- Forks
- 9
- Avg merge
- 9d 9h
- Merged PRs (30d)
- 8
Description
Docstrings has a different way of handling links, code-highlighting, etc. We should dedicate some time to give the documentation a pass ensuring the website renders properly:
One non-critical issue with how the rendered docs look. @gvegayon, your call whether to fix here or merge and make a separate issue to fix.
Originally posted by @dylanhmorris in https://github.com/CDCgov/multisignal-epi-inference/pull/217#pullrequestreview-2157362091
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.
Assessment
This issue has not been assessed yet.