public_mirrors
/
buildroot
mirror of https://github.com/godotengine/buildroot.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

docs/manual: PEP8 coding style for Python scripts 

The advantages of using a pre-existing coding style instead of creating
our own are:
- documenting on the manual takes a single sentence;
- there are automatic tools to help during development/review.

So document that PEP8 recommendation should be followed.

Cc: Arnout Vandecappelle <arnout@mind.be>
Cc: Maxime Hadjinlian <maxime.hadjinlian@gmail.com>
Cc: Samuel Martin <s.martin49@gmail.com>
Cc: Thomas De Schampheleire <thomas.de_schampheleire@nokia.com>
Signed-off-by: Ricardo Martincoski <ricardo.martincoski@gmail.com>
Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
This commit is contained in:
Ricardo Martincoski 2017-04-23 22:33:56 -03:00 committed by Peter Korsgaard
parent 3a66a81b7a
commit bb1c63763d
1 changed files with 5 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
docs/manual/writing-rules.txt
View File

@ -143,3 +143,8 @@ http://www.methods.co.nz/asciidoc/[asciidoc] format.
For further details about the http://www.methods.co.nz/asciidoc/[asciidoc]
syntax, refer to http://www.methods.co.nz/asciidoc/userguide.html[].
=== Support scripts
Some scripts in the +support/+ directory are written in Python and should follow
the https://www.python.org/dev/peps/pep-0008/[PEP8 Style Guide for Python Code].