diff options
| author | Stephen Finucane <stephen@that.guru> | 2016-12-21 20:39:54 +0000 |
|---|---|---|
| committer | Ben Pfaff <blp@ovn.org> | 2016-12-21 13:36:49 -0800 |
| commit | 93d379fc6dafd18e7ed5f684fd91df9e8db14edb (patch) | |
| tree | fafebbe283ea4fda65f2fae11fd758febd3ab659 /Documentation/internals | |
| parent | b8d24cc8a86be46caad00fdae96ff479a64d9b64 (diff) | |
| download | openvswitch-93d379fc6dafd18e7ed5f684fd91df9e8db14edb.tar.gz | |
doc: Prefer use of 'code-block' directive
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>
Signed-off-by: Ben Pfaff <blp@ovn.org>
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 ``$``. |