summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorChandan Singh <chandan@chandansingh.net>2019-11-27 20:34:37 +0000
committerChandan Singh <chandan@chandansingh.net>2019-11-27 20:34:37 +0000
commit05aaf3eadff2981fe3c16e6c3a808c37f0ca1187 (patch)
treec0bba466cf69f59667c0a557f31bde6072e590be
parent205de65db18c0b310c87a58fb9a288251955a117 (diff)
parent96b3975e7abac91522d8d064a2ea7e147f96295e (diff)
downloadbuildstream-05aaf3eadff2981fe3c16e6c3a808c37f0ca1187.tar.gz
Merge branch 'chandan/hacking/drop-line-length' into 'master'
doc/coding_guidelines: Drop section about line lengths See merge request BuildStream/buildstream!1735
-rw-r--r--doc/source/hacking/coding_guidelines.rst15
1 files changed, 0 insertions, 15 deletions
diff --git a/doc/source/hacking/coding_guidelines.rst b/doc/source/hacking/coding_guidelines.rst
index 4ba6360b6..ecab2410f 100644
--- a/doc/source/hacking/coding_guidelines.rst
+++ b/doc/source/hacking/coding_guidelines.rst
@@ -25,21 +25,6 @@ Formatting will be checked automatically when running the testsuite on CI. For
details on how to format your code locally, see :ref:`formatting code <contributing_formatting_code>`.
-Line lengths
-''''''''''''
-Regarding laxness on the line length in our linter settings, it should be clarified
-that the line length limit is a hard limit which causes the linter to bail out
-and reject commits which break the high limit - not an invitation to write exceedingly
-long lines of code, comments, or API documenting docstrings.
-
-Code, comments and docstrings should strive to remain written for approximately 80
-or 90 character lines, where exceptions can be made when code would be less readable
-when exceeding 80 or 90 characters (often this happens in conditional statements
-when raising an exception, for example). Or, when comments contain a long link that
-causes the given line to to exceed 80 or 90 characters, we don't want this to cause
-the linter to refuse the commit.
-
-
.. _contributing_documenting_symbols:
Documenting symbols