Skip to content
Snippets Groups Projects
Commit c6e4c808 authored by Taras Lazariv's avatar Taras Lazariv
Browse files

Improve language

parent 7b2f3eb9
No related branches found
No related tags found
2 merge requests!592Automated merge from preview to main,!554Content rules
...@@ -205,7 +205,7 @@ there is a list of conventions w.r.t. spelling and technical wording. ...@@ -205,7 +205,7 @@ there is a list of conventions w.r.t. spelling and technical wording.
* All code blocks and commands should be runnable from a login node or a node within a specific * All code blocks and commands should be runnable from a login node or a node within a specific
partition (e.g., `ml`). partition (e.g., `ml`).
* It should be clear from the [prompt](#list-of-prompts), where the command is run (e.g., local * It should be clear from the [prompt](#list-of-prompts), where the command is run (e.g., local
machine, login node or specific partition). machine, login node, or specific partition).
#### Code Blocks and Syntax Highlighting #### Code Blocks and Syntax Highlighting
...@@ -213,7 +213,7 @@ Providing code blocks and snippets is the meat and bones of this documentation. ...@@ -213,7 +213,7 @@ Providing code blocks and snippets is the meat and bones of this documentation.
Code blocks and command examples should give the general idea of invocation and be as precise as Code blocks and command examples should give the general idea of invocation and be as precise as
possible, i.e., allowing for copy-and-paste. Please mark replaceable code parts and optional and possible, i.e., allowing for copy-and-paste. Please mark replaceable code parts and optional and
required arguments as outlined in the section [required and optional arguments](#unix-rules) below. required arguments as outlined in the section [required and optional arguments](#unix-rules) below.
Long, non-meaningful output should be ommitted. Long, non-meaningful output should be omitted.
We make use of the extension We make use of the extension
[pymdownx.highlight](https://squidfunk.github.io/mkdocs-material/reference/code-blocks/) for syntax [pymdownx.highlight](https://squidfunk.github.io/mkdocs-material/reference/code-blocks/) for syntax
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment