NatLabRockies / NatLabRockies/H2Integrate
Dosctrings throughout H2IntegrateModel
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 26
- Forks
- 44
- Avg merge
- 3d 22h
- Merged PRs (30d)
- 16
Description
Add docstrings to H2IntegrateModel
Some of the functions in H2IntegrateModel have docstrings, but it would be good to buildout docstrings for the rest of the functions for the user docs.
Proposed solution
Do the docstrings.
Alternatives considered
Not do the docstrings, but seems bad.
Additional context
Probably need to check docstrings throughout code, but this seems like an important area for folks to understand the flow of the new code.
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
Locate the Python class H2IntegrateModel and compare its functions with the existing docstrings. Document the remaining functions sufficiently for the user documentation, then verify that the class has consistent coverage and wording.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100