public inbox for gcc-patches@gcc.gnu.org
 help / color / mirror / Atom feed
From: Gerald Pfeifer <gerald@pfeifer.com>
To: "Martin Liška" <mliska@suse.cz>
Cc: gcc-patches@gcc.gnu.org, Gaius Mulley <gaiusmod2@gmail.com>,
	 David Malcolm <dmalcolm@redhat.com>
Subject: Re: [DOCS] Python Language Conventions
Date: Thu, 13 Oct 2022 11:44:26 +0200 (CEST)	[thread overview]
Message-ID: <73efef2e-0a77-529c-73b3-1164480d3a86@pfeifer.com> (raw)
In-Reply-To: <d77b6541-1a2a-f15d-6855-14e206081fa4@suse.cz>

[-- Attachment #1: Type: text/plain, Size: 973 bytes --]

Hi Martin,

On Thu, 13 Oct 2022, Martin Liška wrote:
> I think we should add how Python scripts should be formatted. I noticed
> that while reading the Modula-2 patchset where it follows the C/C++ style
> when it comes to Python files.

good initiative, thank you! This makes sense to me, alas I'm not a Python 
hacker, so best wait to see what David and Gaius think, too?


Some suggestions on the web side of things:

> +<li><a href="#Python_Conventions">Python Language Conventions</a>

Since the name of the page already is codingconventions.html, I suggest
making this simply "#python" - shorter and simpler. :-)

> +Python scripts should follow <a href="https://peps.python.org/pep-0008/">PEP 8 – Style Guide for Python Code</a>
> +which can be verified by <a href="flake8.pycqa.org">flake8</a> tool.

...by the...tool.

> +We do also recommend using the following <code>flake8</code> plug-ins:

Here maybe simply say "We recommend using"?

Hope this helps,
Gerald

  reply	other threads:[~2022-10-13  9:44 UTC|newest]

Thread overview: 10+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-10-13  9:37 Martin Liška
2022-10-13  9:44 ` Gerald Pfeifer [this message]
2022-10-13 17:16   ` David Malcolm
2022-10-13 20:58     ` Gaius Mulley
2022-10-17 13:06     ` Martin Liška
2022-10-20 11:34       ` Gerald Pfeifer
2022-10-20 11:53         ` Martin Liška
2022-10-13 10:03 ` Richard Sandiford
2022-10-13 10:16   ` Martin Liška
2022-10-13 14:05     ` Richard Sandiford

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=73efef2e-0a77-529c-73b3-1164480d3a86@pfeifer.com \
    --to=gerald@pfeifer.com \
    --cc=dmalcolm@redhat.com \
    --cc=gaiusmod2@gmail.com \
    --cc=gcc-patches@gcc.gnu.org \
    --cc=mliska@suse.cz \
    /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 read-only IMAP folder(s) and NNTP newsgroup(s).