Reducing the verbosity of the tutorial

[ConnorWelch-OSU]

Summary of Changes

This PR address the verbosity of the tutorial identified in #442. To reduce verbosity, repeated examples of XML blocks were removed, leaving only a template for each section of an input file. Additionally, minor changes to the text around where XML blocks were removed has been edited to fit the new context that it exists in.

Design Notes

I did not remove the XML blocks that users can use to check that their input files are correct that are at the end of some pages. There is a discussion to be had on whether these are something that we want to keep or not.

Check the box if your change does not break any of the following:

• API for Cyclus modules
• Input files
• Output tables for post processing tools

Related CEPs and Issues

Fixes #442

Associated Developers

Testing and Validation

• I have read the Contributing to Cyclus guide
• I have compiled and run the code locally
• I have added or updated relevant tests
• I have added documentation for new or changed features
• This code follows the style guide
• I have updated the changelog

Reviewers, please refer to the Cyclus Guide for Reviewers.

[abachma2]

Thanks for doing this @ConnorWelch-OSU. I think this PR accomplishes the goal of removing some verbosity from the tutorial.

In the add_arche, add_commod_recipe and sim_parm files, it looks like you took out the completed blocks for users to compare against, but kept those in add_proto and add_reg_inst. Any reason for that inconsistency? I think having the completed blocks in the tutorial before the final input file has value.

[abachma2]

Do we still need this if we don't have the completed control block anymore?

[ConnorWelch-OSU]

My thinking in leaving it was that the template that appears earlier in the page does contain the two blank lines. It might make more sense to have it further up the page in the section that describes the different parts of the template. I can make that change if its what we want.

[abachma2]

Please add in those sections. I think they are valuable and make things more consistent.

[ConnorWelch-OSU]

In the add_arche, add_commod_recipe and sim_parm files, it looks like you took out the completed blocks for users to compare against, but kept those in add_proto and add_reg_inst. Any reason for that inconsistency?

I agree that having completed blocks has value. My opinion is that the completed block should appear in a "Check" section at the end of each page, and that's how they are in add_proto and add_reg_inst. I can add completed blocks back to the ends of the other pages in a "Check" section, if everyone thinks that's a good idea.