DPDK patches and discussions
 help / color / mirror / Atom feed
From: "Juraj Linkeš" <juraj.linkes@pantheon.tech>
Cc: dev@dpdk.org, "Juraj Linkeš" <juraj.linkes@pantheon.tech>
Subject: [PATCH v1 2/2] doc: increase python max line to 88
Date: Thu,  3 Nov 2022 13:29:26 +0000	[thread overview]
Message-ID: <20221103132926.445627-3-juraj.linkes@pantheon.tech> (raw)
In-Reply-To: <20221103132926.445627-1-juraj.linkes@pantheon.tech>

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@iol.unh.edu>
Signed-off-by: Juraj Linkeš <juraj.linkes@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


  parent reply	other threads:[~2022-11-03 13:29 UTC|newest]

Thread overview: 36+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-11-03 13:29 [PATCH v1 0/2] python gitignore and line length Juraj Linkeš
2022-11-03 13:29 ` [PATCH v1 1/2] git: ignore standard python files Juraj Linkeš
2022-11-04  9:16   ` Juraj Linkeš
2022-11-04  9:26   ` Bruce Richardson
2023-07-16 18:11   ` [PATCH] doc: fix description of runtime directories Stephen Hemminger
2023-07-20  3:26     ` Thomas Monjalon
2022-11-03 13:29 ` Juraj Linkeš [this message]
2022-11-04  9:16   ` [PATCH v1 2/2] doc: increase python max line to 88 Juraj Linkeš
2022-11-04  9:28     ` Bruce Richardson
2022-11-04 16:57     ` Stephen Hemminger
2022-11-10  9:15       ` Juraj Linkeš
2022-11-10 16:27         ` Stephen Hemminger
2023-09-26 12:10   ` [PATCH v2 1/2] doc: increase python max line length to 100 Juraj Linkeš
2023-09-26 12:10     ` [PATCH v2 2/2] dts: reformat to 100 line length Juraj Linkeš
2023-09-26 21:52       ` Jeremy Spewock
2023-09-28  7:27         ` Juraj Linkeš
2023-09-27  8:08       ` Bruce Richardson
2023-09-28  7:33         ` Juraj Linkeš
2023-09-28  8:42           ` Bruce Richardson
2023-09-26 13:00     ` [PATCH v2 1/2] doc: increase python max line length to 100 Bruce Richardson
2023-09-28 12:18     ` [PATCH v3 " Juraj Linkeš
2023-09-28 12:18       ` [PATCH v3 2/2] dts: reformat to 100 line length Juraj Linkeš
2023-09-29 16:53         ` Jeremy Spewock
2023-10-13  7:58         ` [PATCH v4 1/2] doc: increase python max line length to 100 Juraj Linkeš
2023-10-13  7:58           ` [PATCH v4 2/2] dts: reformat to 100 line length Juraj Linkeš
2023-10-16  6:45             ` [PATCH v5 1/2] doc: increase python max line length to 100 Juraj Linkeš
2023-10-16  6:45               ` [PATCH v5 2/2] dts: reformat to 100 line length Juraj Linkeš
2023-11-20 12:36                 ` [PATCH v6 1/2] doc: increase python max line length to 100 Juraj Linkeš
2023-11-20 12:36                   ` [PATCH v6 2/2] dts: reformat to 100 line length Juraj Linkeš
2023-11-20 16:50                     ` Thomas Monjalon
2023-11-21  9:27                       ` Juraj Linkeš
2023-10-13 16:09           ` [PATCH v4 1/2] doc: increase python max line length to 100 Stephen Hemminger
2023-10-16  6:44             ` Juraj Linkeš
2023-10-12 12:52       ` [PATCH v3 " Paul Szczepanek
2023-10-13  7:56         ` Juraj Linkeš
2022-11-04  9:15 ` [PATCH v1 0/2] python gitignore and line length Juraj Linkeš

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20221103132926.445627-3-juraj.linkes@pantheon.tech \
    --to=juraj.linkes@pantheon.tech \
    --cc=dev@dpdk.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).