[PATCH] D62916: Add note about python to CodingStandards

Sam Clegg via Phabricator via llvm-commits llvm-commits at lists.llvm.org
Wed Jun 5 09:57:45 PDT 2019


sbc100 created this revision.
Herald added subscribers: llvm-commits, aheejin.
Herald added a project: LLVM.
sbc100 added a reviewer: pcc.

Seems like there is enough python code in LLVM (1432 files and 222k
lines) to warrant a mention here.


Repository:
  rG LLVM Github Monorepo

https://reviews.llvm.org/D62916

Files:
  llvm/docs/CodingStandards.rst


Index: llvm/docs/CodingStandards.rst
===================================================================
--- llvm/docs/CodingStandards.rst
+++ llvm/docs/CodingStandards.rst
@@ -189,6 +189,9 @@
 Other Languages
 ---------------
 
+Go
+^^
+
 Any code written in the Go programming language is not subject to the
 formatting rules below. Instead, we adopt the formatting rules enforced by
 the `gofmt`_ tool.
@@ -205,6 +208,23 @@
 .. _Go Code Review Comments:
   https://github.com/golang/go/wiki/CodeReviewComments
 
+Python
+^^^^^^
+
+Any code written in the Python programming language is not subject to the
+formatting rules below. Instead, we adopt the formatting rules specified by
+Python's `PEP8`_ standard.  This can be verified by tools such as `flake8`_ and
+`pep8`_
+
+.. _PEP8:
+  https://www.python.org/dev/peps/pep-0008/
+
+.. _flake8:
+  http://flake8.pycqa.org/en/latest/
+
+.. _pep8:
+  https://pypi.org/project/pep8/
+
 Mechanical Source Issues
 ========================
 


-------------- next part --------------
A non-text attachment was scrubbed...
Name: D62916.203188.patch
Type: text/x-patch
Size: 989 bytes
Desc: not available
URL: <http://lists.llvm.org/pipermail/llvm-commits/attachments/20190605/0e188c7a/attachment.bin>


More information about the llvm-commits mailing list