cyclus / cyclus/cyclus.github.com
fix incorrect explanation of inventories type.
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 8
- Forks
- 33
- PR merge metrics
- No merged PRs in 30d
Description
The section here: http://fuelcycle.org/arche/cycpp.html#inventories is incorrect about Inventories type. Inventories is strictly for snapshot and restart. Archetypes should not use it as a state variable. They should only use ResBuf (or ResMap).
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.
Research direction
Open the Inventories section at the linked cycpp.html page and review its explanation against the issue description. Update the documentation so Inventories is described only in the snapshot and restart context, while archetype state uses ResBuf or ResMap. Done means the section no longer recommends Inventories as an archetype state variable.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 45/100