-
Notifications
You must be signed in to change notification settings - Fork 32
Open
Description
What is this task about?
@ConnorWelch-OSU and I were discussing adding a Structure and Syntax page to the tutorials before the sim_parm.rst. There is a lot of miscellaneous information in the current tutorials that is important and could be shoved in here. Some examples that we have seen include
- Footnote mentioning xml block ordering
- the
Noteat the end of the simulation parameters page about the ending tag etc - Commodity block being optional
- No hyphens
- Capitalization specifications for tags/names matters
- any syntax related, structural, Cyclus specific stuff
It could be thought of as a mini-rule/guide book before going into the tutorials. This information seems pretty relevant but may get lost.
Why is this task needed?
This task could contribute to issue #442 and could centralize some important but less FC related information.
This is just a small idea and maybe could be handled without a whole separate tutorial page. Other option could include making all offhanded information that is important footnotes for consistency.
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
No labels