cyclus / cyclus/cyclus.github.com
Semantically incorrect Cyclus Testing heading
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 8
- Forks
- 33
- PR merge metrics
- No merged PRs in 30d
Description
The heading that reads on the cyclus user docs:
Cyclus Testing
The Cyclus kernel includes some archetype for testing the basic functionality of the kenel.
Cyclus Archetypes
:agents:Source
:agents:Sink
:agents:NullRegion
:agents:NullInst
:agents:KFacility
:agents:Predator
:agents:Prey
is not right. Not all of these archetypes are for testing and I would argue that some, such as the Nulls are needed for day-to-day usage.
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
Start in the Cyclus user documentation at the section headed “Cyclus Testing” and review the listed archetypes and its explanatory text. Rename or revise the heading so it accurately describes the archetypes, then verify the rendered documentation reflects that distinction.
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
- Mostly clear
- Newbie friendliness
- 45/100