diff options
Diffstat (limited to 'Documentation/internals')
| -rw-r--r-- | Documentation/internals/contributing/documentation-style.rst | 3 |
1 files changed, 2 insertions, 1 deletions
diff --git a/Documentation/internals/contributing/documentation-style.rst b/Documentation/internals/contributing/documentation-style.rst index c32921e70..318cc81ef 100644 --- a/Documentation/internals/contributing/documentation-style.rst +++ b/Documentation/internals/contributing/documentation-style.rst @@ -111,7 +111,8 @@ Code ~~~~ - Use ``::``, the ``code`` role or the ``code-block:: <syntax>`` role to prefix - code. + code. The ``code-block:: <syntax>`` format is preferred as this provides + syntax highlighting for non-Python languages, such as Bash or PowerShell. - Prefix commands with ``$``. |