Notes for authors

6. Notes for authors#

See https://jupyterbook.org/en/stable/content/myst.html
Move to MyST Markdown notation {ref}, {doc}, {eq} and so on as appropriate. I now prefer to use {ref} rather than {doc} where one can have a myST label to the top-level section of a file.
References to other sections and subsections within them work best using enhanced mark-down style [text](label), with the second entry being a myST label. For example: section Error bounds for linear algebra etc., subsection Matrix norms.
To number equations for referencing, use MyST-Markdown-augmented $$...$$ notation, as with $$2+2=4$$ (eq-obvious)
If the top-level section atop a file is labelled as with “(section-label)=” then either the {ref}section-label-in-back-quotes syntax or “enhanced markdown” syntax [text](section-label)can be used instead of {doc}file-base-name-in-back-quotes This avoids the ned to keep track of which folder a file is in, and is useful when there are variant files distinguished by suffixes like “-python”/”-julia” but one wants to use the same cross-reference label.
- For example, Runge-Kutta Methods or Runge-Kutta Methods vs Runge-Kutta Methods.
When using <br>, it should appear on its own line, not at end-of-line. (For PDF output; HTML output is more forgiving.) This is relevant to some pseudo-code appearence in the PDF; e.g in Euler’s Method

Gather exercises in a subsection Exercises at the end of each section, and format them with myST’s “{exercise-start}/{exercise-end}”, as done in Runge-Kutta Methods. Done for
Number and label exercises as done by myST’s “{exercise-start}/{exercise-end}”
Abandon the misguided CamelCasing: revert to standard Python and Julia style of snake_case for names of functions, variable and modules (and ALL_CAPS_SNAKE_CASE for constants, if any).
- For example, it has been changed (back) to numerical_methods from numericalMethods.
Aside: Julia style agrees on snake_case for variable and function names, but prefers CamelCase for modules and indeed everything else.