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

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.

Ready to be installed?
Thanks,
Martin

---
 htdocs/codingconventions.html | 14 ++++++++++++++
 1 file changed, 14 insertions(+)

diff --git a/htdocs/codingconventions.html b/htdocs/codingconventions.html
index e4d30510..180ef35a 100644
--- a/htdocs/codingconventions.html
+++ b/htdocs/codingconventions.html
@@ -80,6 +80,7 @@ the conventions separately from any other changes to the code.</p>
     </li>
     </ul>
 </li>
+<li><a href="#Python_Conventions">Python Language Conventions</a>
 </ul>
 
 
@@ -1483,6 +1484,19 @@ with a right brace, optional closing comment, and a new line.
 Definitions within the body of a namespace are not indented.
 </p>
 
+<h2 id="Python_Conventions">Python Language Conventions</h2>
+
+<p>
+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.
+We do also recommend using the following <code>flake8</code> plug-ins:
+
+<ul>
+    <li>flake8-builtins</li>
+    <li>flake8-import-order</li>
+    <li>flake8-quotes</li>
+</ul>
+</p>
 
 </body>
 </html>
-- 
2.37.3


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

Thread overview: 10+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-10-13  9:37 Martin Liška [this message]
2022-10-13  9:44 ` Gerald Pfeifer
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=d77b6541-1a2a-f15d-6855-14e206081fa4@suse.cz \
    --to=mliska@suse.cz \
    --cc=dmalcolm@redhat.com \
    --cc=gaiusmod2@gmail.com \
    --cc=gcc-patches@gcc.gnu.org \
    --cc=gerald@pfeifer.com \
    /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).