cyclus / cyclus/cyclus.github.com

Condensing Miscellaneous Structure/Syntax Rules in Tutorials

Open
#445 0 comments 0 reactions 0 assignees View on GitHub

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?

@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 Note at 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.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Review the current tutorials and sim_parm.rst, along with issue #442, to locate the scattered structure and syntax guidance listed here. Decide whether the material belongs in a new Structure and Syntax page or consistent footnotes, then ensure the selected documentation contains the relevant rules without losing existing information.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.