From c6e4c808e0d5323aebce54e90ee025613a3c783c Mon Sep 17 00:00:00 2001 From: lazariv <taras.lazariv@tu-dresden.de> Date: Fri, 20 May 2022 13:31:55 +0000 Subject: [PATCH] Improve language --- doc.zih.tu-dresden.de/docs/contrib/content_rules.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc.zih.tu-dresden.de/docs/contrib/content_rules.md b/doc.zih.tu-dresden.de/docs/contrib/content_rules.md index fa4837d08..3596f6067 100644 --- a/doc.zih.tu-dresden.de/docs/contrib/content_rules.md +++ b/doc.zih.tu-dresden.de/docs/contrib/content_rules.md @@ -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 partition (e.g., `ml`). * 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 @@ -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 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. -Long, non-meaningful output should be ommitted. +Long, non-meaningful output should be omitted. We make use of the extension [pymdownx.highlight](https://squidfunk.github.io/mkdocs-material/reference/code-blocks/) for syntax -- GitLab