From: Markus Armbruster <email@example.com> To: Peter Maydell <firstname.lastname@example.org> Cc: QEMU Developers <email@example.com>, Michael Roth <firstname.lastname@example.org>, John Snow <email@example.com>, Eduardo Habkost <firstname.lastname@example.org>, Cleber Rosa <email@example.com> Subject: Re: [PATCH v4 02/19] flake8: Enforce shorter line length for comments and docstrings Date: Thu, 08 Apr 2021 10:32:06 +0200 [thread overview] Message-ID: <firstname.lastname@example.org> (raw) In-Reply-To: <CAFEAcA8f-d7fPzrisUVkjkvpD0CCdQFBso3GiFmAPJ6gj-P_mg@mail.gmail.com> (Peter Maydell's message of "Fri, 26 Mar 2021 16:44:25 +0000") Peter Maydell <email@example.com> writes: > On Fri, 26 Mar 2021 at 16:33, John Snow <firstname.lastname@example.org> wrote: >> Being less terse about it: Mostly, I don't like how it enforces this >> column width even for indented structures. Generally, we claim that 72 >> columns is "comfortable to read" and I agree. >> >> However, when we start in a margin, I >> am not convinced that this is >> actually more readable than the >> alternative. We aren't using our full >> 72 characters here. > > I agree, and I don't see any strong reason to hold our Python > code to a different standard to the rest of our codebase as > regards line length and comment standards. I can't see much of a conflict between canonical Python style and the rest of our code. (If there was a conflict, then I'd doubt we should hold our Python code to a different standard than pretty much all the other Python code out there.) PEP 8 is expressly a *guide*. It doesn't want to be treated as law. It tells you when to ignore its guidance even before it gives any, right in the second section. Applicable part: Some other good reasons to ignore a particular guideline: 1. When applying the guideline would make the code less readable, even for someone who is used to reading code that follows this PEP. Going beyond 72 colums to make the comment more readable is exactly what PEP 8 wants you to do. This is no excuse for going beyond when you could just as well break the line earlier. There's a reason pycodestyle distinguishes between errors and warnings, and "line too long" is a warning. We've been conditioned to conflate warnings with errors by C's "the standard permits it, but you really shouldn't" warnings. However, treating style warnings as errors is exactly what PEP 8 calls a folly of little minds.
next prev parent reply other threads:[~2021-04-08 8:34 UTC|newest] Thread overview: 59+ messages / expand[flat|nested] mbox.gz Atom feed top 2021-03-25 6:03 [PATCH v4 00/19] qapi: static typing conversion, pt3 John Snow 2021-03-25 6:03 ` [PATCH v4 01/19] qapi/expr: Comment cleanup John Snow 2021-03-25 15:41 ` Markus Armbruster 2021-03-25 20:06 ` John Snow 2021-03-25 6:03 ` [PATCH v4 02/19] flake8: Enforce shorter line length for comments and docstrings John Snow 2021-03-25 15:21 ` Markus Armbruster 2021-03-25 20:20 ` John Snow 2021-03-26 6:26 ` Markus Armbruster 2021-03-26 16:30 ` John Snow 2021-03-26 16:44 ` Peter Maydell 2021-04-08 8:32 ` Markus Armbruster [this message] 2021-04-08 8:58 ` Daniel P. Berrangé 2021-04-09 9:33 ` Markus Armbruster 2021-04-09 17:08 ` John Snow 2021-04-08 8:35 ` Markus Armbruster 2021-04-16 12:44 ` Markus Armbruster 2021-04-16 20:25 ` John Snow 2021-04-17 10:52 ` Markus Armbruster 2021-04-20 18:06 ` John Snow 2021-03-25 6:03 ` [PATCH v4 03/19] qapi/expr.py: Remove 'info' argument from nested check_if_str John Snow 2021-03-25 6:03 ` [PATCH v4 04/19] qapi/expr.py: Check for dict instead of OrderedDict John Snow 2021-03-25 6:03 ` [PATCH v4 05/19] qapi/expr.py: constrain incoming expression types John Snow 2021-03-25 14:04 ` Markus Armbruster 2021-03-25 20:48 ` John Snow 2021-03-26 5:40 ` Markus Armbruster 2021-03-26 17:12 ` John Snow 2021-03-25 6:03 ` [PATCH v4 06/19] qapi/expr.py: Add assertion for union type 'check_dict' John Snow 2021-03-25 6:03 ` [PATCH v4 07/19] qapi/expr.py: move string check upwards in check_type John Snow 2021-03-25 6:03 ` [PATCH v4 08/19] qapi: add tests for invalid 'data' field type John Snow 2021-03-25 14:24 ` Markus Armbruster 2021-03-25 6:03 ` [PATCH v4 09/19] qapi/expr.py: Check type of 'data' member John Snow 2021-03-25 14:26 ` Markus Armbruster 2021-03-25 21:04 ` John Snow 2021-03-25 6:03 ` [PATCH v4 10/19] qapi/expr.py: Add casts in a few select cases John Snow 2021-03-25 14:33 ` Markus Armbruster 2021-03-25 23:32 ` John Snow 2021-03-25 6:03 ` [PATCH v4 11/19] qapi/expr.py: Modify check_keys to accept any Collection John Snow 2021-03-25 14:45 ` Markus Armbruster 2021-03-25 23:37 ` John Snow 2021-03-25 6:03 ` [PATCH v4 12/19] qapi/expr.py: add type hint annotations John Snow 2021-03-25 6:03 ` [PATCH v4 13/19] qapi/expr.py: Consolidate check_if_str calls in check_if John Snow 2021-03-25 15:15 ` Markus Armbruster 2021-03-26 0:07 ` John Snow 2021-03-25 6:03 ` [PATCH v4 14/19] qapi/expr.py: Remove single-letter variable John Snow 2021-03-25 6:03 ` [PATCH v4 15/19] qapi/expr.py: enable pylint checks John Snow 2021-03-25 6:03 ` [PATCH v4 16/19] qapi/expr.py: Add docstrings John Snow 2021-04-14 15:04 ` Markus Armbruster 2021-04-17 1:00 ` John Snow 2021-04-17 13:18 ` Markus Armbruster 2021-04-21 1:27 ` John Snow 2021-04-21 13:58 ` Markus Armbruster 2021-04-21 18:20 ` John Snow 2021-03-25 6:03 ` [PATCH v4 17/19] qapi/expr.py: Use tuples instead of lists for static data John Snow 2021-03-25 15:19 ` Markus Armbruster 2021-03-25 6:03 ` [PATCH v4 18/19] qapi/expr.py: move related checks inside check_xxx functions John Snow 2021-03-25 6:03 ` [PATCH v4 19/19] qapi/expr.py: Use an expression checker dispatch table John Snow 2021-03-25 15:46 ` [PATCH v4 00/19] qapi: static typing conversion, pt3 Markus Armbruster 2021-03-26 0:40 ` John Snow 2021-03-26 18:01 ` John Snow
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 \ --email@example.com \ --firstname.lastname@example.org \ --email@example.com \ --firstname.lastname@example.org \ --email@example.com \ --firstname.lastname@example.org \ --email@example.com \ --firstname.lastname@example.org \ --subject='Re: [PATCH v4 02/19] flake8: Enforce shorter line length for comments and docstrings' \ /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
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).