diff options
| author | rebortg <github@ghlr.de> | 2020-12-10 11:59:42 +0100 |
|---|---|---|
| committer | rebortg <github@ghlr.de> | 2020-12-10 11:59:42 +0100 |
| commit | 763324b0c17c9f6724589c2f2c590b4e611a2347 (patch) | |
| tree | 04145ee8fc403817628cf594c64e22797de795df /docs/contributing/documentation.rst | |
| parent | 95a2a8af1835a3409430e24352056f44ba07e6c5 (diff) | |
| download | vyos-documentation-763324b0c17c9f6724589c2f2c590b4e611a2347.tar.gz vyos-documentation-763324b0c17c9f6724589c2f2c590b4e611a2347.zip | |
styleguide: specify line lenght and exception
Diffstat (limited to 'docs/contributing/documentation.rst')
| -rw-r--r-- | docs/contributing/documentation.rst | 10 |
1 files changed, 10 insertions, 0 deletions
diff --git a/docs/contributing/documentation.rst b/docs/contributing/documentation.rst index ddd21396..f1dc8095 100644 --- a/docs/contributing/documentation.rst +++ b/docs/contributing/documentation.rst @@ -153,6 +153,16 @@ system numbers for the documentation: Please don't use other public address space. + +Line length +^^^^^^^^^^^ + +Limit all lines to a maximum of 79 characters. + +Except in ``.. code-block::`` because it will use the html tag ``<pre>`` +which have the save line format as in the rst file. + + Custom Sphinx-doc Markup ^^^^^^^^^^^^^^^^^^^^^^^^ |