documentation review #1118
Merged
documentation review #1118
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Updated documentation as per my allocation in #1114
Landing page had one or two non-``_``'d Sorcha's. Also added a link to the demo notebooks to make explicit how we've validated to anyone coming to the page for review (which meant adding a tag in the notebooks.rst file to reference to). Also was a linguistics pedant and updated the origin of Sorcha as being derived from and not literally meaning "light"/"brightness" :P
Parallelisation/HPC page was more or less perfect, capitalised Slurm in-text, ensured correct usage of in-line code blocks, fixed some command line flags in the Best Practices section being single and not double -'d