cyclus / cyclus/cyclus.github.com
[Task] Improve comments in the final XML files generated by tutorials
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 8
- Forks
- 33
- PR merge metrics
- No merged PRs in 30d
Description
What is this task about?
We publish XML files that represent the end state of each tutorial. Those files don't provide any context for why the file is structured the way it is, where that context is defined by the tutorials themselves.
Why is this task needed?
Some users don't go through the tutorials so don't have the context, and may be confused by the examples.
How can this issue be closed?
Add comments to the XML files that provide context and describe some of the reasons that the file is structured as it is including various choices.
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
Locate the final XML files published for each tutorial and compare them with the tutorial sources that define their structure. Add comments explaining the context and structural choices, then verify that the comments accurately reflect the tutorials and that all final XML examples remain valid.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- xml
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100