From: Ricardo Martincoski Date: Mon, 24 Apr 2017 01:33:56 +0000 (-0300) Subject: docs/manual: PEP8 coding style for Python scripts X-Git-Tag: 2017.05-rc1~231 X-Git-Url: http://rtime.felk.cvut.cz/gitweb/coffee/buildroot.git/commitdiff_plain/bb1c63763d862419e22f30b90fcd5179d40a0c5a 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 Cc: Maxime Hadjinlian Cc: Samuel Martin Cc: Thomas De Schampheleire Signed-off-by: Ricardo Martincoski Signed-off-by: Peter Korsgaard --- diff --git a/docs/manual/writing-rules.txt b/docs/manual/writing-rules.txt index e2ad41ebc3..3a2c8dcb37 100644 --- a/docs/manual/writing-rules.txt +++ b/docs/manual/writing-rules.txt @@ -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].