NatLabRockies / NatLabRockies/H2Integrate
Add a description of the config file and using the attrs library to the docs page
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 26
- Forks
- 44
- Avg merge
- 3d 22h
- Merged PRs (30d)
- 16
Description
Add a description of the config file and using the attrs library to the docs page
The documentation current talks about some aspects of adding a new model, but it does not describe how to use the base config or mention the attrs functionality that we use in H2I. We should add a description of how the configs are used in H2I, and an example of how to use attrs to manipulate the inputs (e.g. attrs post init), plus link to some attrs docs.
Proposed solution
Alternatives considered
Additional context
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 by locating the documentation page that explains adding a new model and reviewing its current discussion of configuration. Document how the base config is used in H2I, add an attrs example covering input manipulation such as post-init behavior, and link to relevant attrs documentation; the page should clearly cover all three points when complete.
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
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 68/100