summaryrefslogtreecommitdiff
path: root/docs/contributing
diff options
context:
space:
mode:
authorChristian Poessinger <christian@poessinger.com>2019-11-06 19:27:50 +0100
committerChristian Poessinger <christian@poessinger.com>2019-11-06 19:27:50 +0100
commitbdf0451c616f2f60e4b3fbcf19db400a695602eb (patch)
tree40489266ac7c4316ab7a3966310d33865fc759eb /docs/contributing
parent10663220843fc5fcee84512d71e742f8d157e7ce (diff)
downloadvyos-documentation-bdf0451c616f2f60e4b3fbcf19db400a695602eb.tar.gz
vyos-documentation-bdf0451c616f2f60e4b3fbcf19db400a695602eb.zip
contribution: add Python node about 80 character limit
Diffstat (limited to 'docs/contributing')
-rw-r--r--docs/contributing/coding_guidelines.rst8
1 files changed, 8 insertions, 0 deletions
diff --git a/docs/contributing/coding_guidelines.rst b/docs/contributing/coding_guidelines.rst
index 771290ca..634c3e61 100644
--- a/docs/contributing/coding_guidelines.rst
+++ b/docs/contributing/coding_guidelines.rst
@@ -28,6 +28,14 @@ interface.
Configuration script structure and behaviour
--------------------------------------------
+Your configuration script or operation mode script which is also written in
+Python3 should have a line break on 80 characters. This seems to be a bit odd
+nowadays but as some people also work remotly or programm using vi(m) this is
+a fair good standard which I hope we can rely on.
+
+In addition this also helps when browsing the GitHub codebase on a mobile
+device if you happen to be a crazy scientist.
+
.. code-block:: python
#!/usr/bin/env python3