This is an archive of the discontinued LLVM Phabricator instance.

Differential D62916

Add note about python to CodingStandards
AbandonedPublic

Authored by sbc100 on Jun 5 2019, 9:56 AM.

Details

Reviewers
pcc
Summary

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

Diff Detail

Event Timeline

sbc100 created this revision.Jun 5 2019, 9:56 AM
Herald added a project: Restricted Project. · View Herald TranscriptJun 5 2019, 9:56 AM
Herald added subscribers: llvm-commits, aheejin. · View Herald Transcript
sbc100 added a reviewer: pcc.Jun 5 2019, 9:56 AM
Harbormaster completed remote builds in B32939: Diff 203188.Jun 5 2019, 9:57 AM
sbc100 abandoned this revision.May 31 2023, 11:02 AM

Abandoning now that https://reviews.llvm.org/D143852 has landed.

Herald added a project: Restricted Project. · View Herald TranscriptMay 31 2023, 11:02 AM
Herald added a subscriber: wingo. · View Herald Transcript

Revision Contents

PathSize
llvm/
docs/
20 lines

Diff 203188

llvm/docs/CodingStandards.rst

Show First 20 Lines • Show All 183 Lines • ▼ Show 20 Lines
traits header to emulate it. traits header to emulate it.
.. _the libstdc++ manual: .. _the libstdc++ manual:
https://gcc.gnu.org/onlinedocs/gcc-4.8.0/libstdc++/manual/manual/status.html#status.iso.2011 https://gcc.gnu.org/onlinedocs/gcc-4.8.0/libstdc++/manual/manual/status.html#status.iso.2011
Other Languages Other Languages
--------------- ---------------
Go
^^
Any code written in the Go programming language is not subject to the Any code written in the Go programming language is not subject to the
formatting rules below. Instead, we adopt the formatting rules enforced by formatting rules below. Instead, we adopt the formatting rules enforced by
the `gofmt`_ tool. the `gofmt`_ tool.
Go code should strive to be idiomatic. Two good sets of guidelines for what Go code should strive to be idiomatic. Two good sets of guidelines for what
this means are `Effective Go`_ and `Go Code Review Comments`_. this means are `Effective Go`_ and `Go Code Review Comments`_.
.. _gofmt: .. _gofmt:
https://golang.org/cmd/gofmt/ https://golang.org/cmd/gofmt/
.. _Effective Go: .. _Effective Go:
https://golang.org/doc/effective_go.html https://golang.org/doc/effective_go.html
.. _Go Code Review Comments: .. _Go Code Review Comments:
https://github.com/golang/go/wiki/CodeReviewComments 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 Mechanical Source Issues
======================== ========================
Source Code Formatting Source Code Formatting
---------------------- ----------------------
Commenting Commenting
^^^^^^^^^^ ^^^^^^^^^^
▲ Show 20 Lines • Show All 1,514 Lines • Show Last 20 Lines