From: Stephen Hemminger <stephen@networkplumber.org>
To: "Juraj Linkeš" <juraj.linkes@pantheon.tech>
Cc: Honnappa Nagarahalli <Honnappa.Nagarahalli@arm.com>,
Owen Hilyard <ohilyard@iol.unh.edu>,
"thomas@monjalon.net" <thomas@monjalon.net>,
"Lijuan Tu" <lijuan.tu@intel.com>,
"Richardson, Bruce" <bruce.richardson@intel.com>,
"dev@dpdk.org" <dev@dpdk.org>
Subject: Re: [PATCH v1 2/2] doc: increase python max line to 88
Date: Thu, 10 Nov 2022 08:27:24 -0800 [thread overview]
Message-ID: <20221110082724.1b5b8fab@hermes.local> (raw)
In-Reply-To: <74ab4d2606234790928087292ef81576@pantheon.tech>
On Thu, 10 Nov 2022 09:15:16 +0000
Juraj Linkeš <juraj.linkes@pantheon.tech> wrote:
> > -----Original Message-----
> > From: Stephen Hemminger <stephen@networkplumber.org>
> > Sent: Friday, November 4, 2022 5:58 PM
> > To: Juraj Linkeš <juraj.linkes@pantheon.tech>
> > Cc: Honnappa Nagarahalli <Honnappa.Nagarahalli@arm.com>; Owen Hilyard
> > <ohilyard@iol.unh.edu>; thomas@monjalon.net; Lijuan Tu
> > <lijuan.tu@intel.com>; Richardson, Bruce <bruce.richardson@intel.com>;
> > dev@dpdk.org
> > Subject: Re: [PATCH v1 2/2] doc: increase python max line to 88
> >
> > On Fri, 4 Nov 2022 09:16:13 +0000
> > Juraj Linkeš <juraj.linkes@pantheon.tech> wrote:
> >
> > > > +max_line_length = 88 #
> > > >
> > +https://black.readthedocs.io/en/stable/the_black_code_style/current_sty
> > > > +le.html#li
> >
> > Skip the comment, it caused your line break!
>
> The fact that the line is a bit longer does not make the line less readable, as the link is there to be copy-pasted (and I don't think anyone reads the full hyperlinks - the knowledge of domain is enough). As such I think it's better to include the link as it serves as self-documentation (that we're deviating from the standard).
>
> We could move the comment before or after the max_line_length option and that would result in lines below 100 characters (which is what .editorconfig prescribes). I used that in my one of my local versions, but it was less readable in my opinion. I'd rather break the rule and have it be more readable.
>
> Of course, not having the comment is fine, since we document it in the coding style guide. I just think there's no (or very little) downside and some upside (more than downside) in adding the comment.
The choice of max line length is project specific. Referencing some other style guide
doesn't seem necessary. My choice would be to use 100 like the other C code.
next prev parent reply other threads:[~2022-11-10 16:28 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 ` [PATCH v1 2/2] doc: increase python max line to 88 Juraj Linkeš
2022-11-04 9:16 ` 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 [this message]
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=20221110082724.1b5b8fab@hermes.local \
--to=stephen@networkplumber.org \
--cc=Honnappa.Nagarahalli@arm.com \
--cc=bruce.richardson@intel.com \
--cc=dev@dpdk.org \
--cc=juraj.linkes@pantheon.tech \
--cc=lijuan.tu@intel.com \
--cc=ohilyard@iol.unh.edu \
--cc=thomas@monjalon.net \
/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).