ladybug-tools / ladybug-tools/contributing
Add pages to the Wiki describing how to format docstrings for the auto-generated Sphinx docs
Open
Nobody has claimed this yet.
enhancement
- Dominant language
- No language data
- Stars
- 9
- Forks
- 2
- PR merge metrics
- No merged PRs in 30d
Description
@santiagogaray has done a really good job fixing up the online docs for all of the repos. If he could document all of his best practices in the Wiki of this repo, this will give us a reference that all contributors can continue to use into the future.
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 repository's contributing Wiki and review the online Sphinx documentation practices referenced in the issue. Document the best practices for formatting docstrings there so contributors have a reusable reference; done when the relevant guidance is available on the Wiki.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 30/100