Documentation: Methods

[NoraLoose]

There are a few inconsistencies and typos in the method section of the documentation, and it would be helpful to give it a bit more structure (via section headers). Specifically:

• Two different version of phi are used interchangeably. It would make the documentation clearer to stick to only one of the 2 symbols.
• What is "L_pad"?
• "currently implementation" --> "current implementation"
• "An identical equation": identical to what? It may be clearer to label the equation for Delta phi_N above, and than you could write: "An identical equation to [labeled equation]".
• Before writing down the large-scale KE budget, it may be helpful to start a new section with a new section header, e.g., "Large-scale KE budget". It would also be helpful to refer the user to e.g., Aluie et al. (2018) for the derivation.
• New section header before you introduce the Lamba^m equation.
• It would be helpful to introduce a new section header before the sentence "This section outlines some of the parallelizations that are used.", e.g., "Parallelizing computations"
• reoutines --> routines

This issue is part of the JOSS review process over openjournals/joss-reviews#4277.

[bastorer]

Thanks for the feedback! It looks like there was a silent cascading error with header rendering that made the documentation much harder to read. This should now be resolved and much more user-friendly.

[NoraLoose]

I agree - this looks much more user-friendly now! :)

While reading through the documentation, I spotted a few further minor typos (not all in the Methods sections):

• consants --> constants on https://flowsieve.readthedocs.io/en/latest/constants_8hpp.html
• reach --> reached on https://flowsieve.readthedocs.io/en/latest/helmholtz1.html
• "Coarsen the to" --> "Coarsen to" on https://flowsieve.readthedocs.io/en/latest/helmholtz1.html

[bastorer]

Typos corrected :-)

[bastorer]

Also, I've added a --help flag to the executables that gives users more details about the command-line arguments that can be passed at runtime.

[NoraLoose]

Great! This issue can be closed.