[PATCH v1 2/2] doc: increase python max line to 88
Juraj Linkeš
juraj.linkes at pantheon.tech
Thu Nov 3 14:29:26 CET 2022
88 is a good compromise between shorter files,
readability and other considerations. More in [0].
[0] https://black.readthedocs.io/en/stable/the_black_code_style/current_style.html#line-length
Signed-off-by: Owen Hilyard <ohilyard at iol.unh.edu>
Signed-off-by: Juraj Linkeš <juraj.linkes at pantheon.tech>
---
.editorconfig | 2 +-
doc/doc_build/meson-private/meson.lock | 0
doc/guides/contributing/coding_style.rst | 8 +++++++-
3 files changed, 8 insertions(+), 2 deletions(-)
create mode 100644 doc/doc_build/meson-private/meson.lock
diff --git a/.editorconfig b/.editorconfig
index ab41c95085..f20996f329 100644
--- a/.editorconfig
+++ b/.editorconfig
@@ -16,7 +16,7 @@ max_line_length = 100
[*.py]
indent_style = space
indent_size = 4
-max_line_length = 79
+max_line_length = 88 # https://black.readthedocs.io/en/stable/the_black_code_style/current_style.html#line-length
[meson.build]
indent_style = space
diff --git a/doc/doc_build/meson-private/meson.lock b/doc/doc_build/meson-private/meson.lock
new file mode 100644
index 0000000000..e69de29bb2
diff --git a/doc/guides/contributing/coding_style.rst b/doc/guides/contributing/coding_style.rst
index 89db6260cf..7620268dc7 100644
--- a/doc/guides/contributing/coding_style.rst
+++ b/doc/guides/contributing/coding_style.rst
@@ -851,7 +851,13 @@ Python Code
All Python code should be compliant with
`PEP8 (Style Guide for Python Code) <https://www.python.org/dev/peps/pep-0008/>`_.
-The ``pep8`` tool can be used for testing compliance with the guidelines.
+The ``pep8`` tool can be used for testing compliance with the guidelines. Note that the
+maximum line length is 88, as that is a good compromise between shorter files, usability
+with other tools (side-by-side diffs, docs, presentations) and disability accommodation.
+More in `Black's documentation
+<https://black.readthedocs.io/en/stable/the_black_code_style/current_style.html#line-length>`_.
+
+..
Integrating with the Build System
---------------------------------
--
2.30.2
More information about the dev
mailing list