| Message ID | 20161221203954.26353-3-stephen@that.guru |
|---|---|
| State | Accepted |
| Headers | show |
diff --git a/Documentation/internals/contributing/documentation-style.rst b/Documentation/internals/contributing/documentation-style.rst index c32921e..318cc81 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 ``$``.
The '::' element previously preferred is shorter, but does not allow for non-Python syntax highlighting. New documentation should make use of syntax highlighting wherever possible. Signed-off-by: Stephen Finucane <stephen@that.guru> --- Documentation/internals/contributing/documentation-style.rst | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-)