From 8626ef32e9443353d40ec44d4a0c69deac011efb Mon Sep 17 00:00:00 2001 From: Heinrich Schuchardt Date: Wed, 19 Apr 2023 08:45:34 +0200 Subject: [PATCH] doc: codingstyle: Python coding style Indicate that we follow PEP8 and PEP257. Signed-off-by: Heinrich Schuchardt Reviewed-by: Simon Glass --- doc/develop/codingstyle.rst | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/doc/develop/codingstyle.rst b/doc/develop/codingstyle.rst index 1d5d019..3d05a6b 100644 --- a/doc/develop/codingstyle.rst +++ b/doc/develop/codingstyle.rst @@ -19,6 +19,10 @@ The following rules apply: applies only to Linux, not to U-Boot. Only large hunks which are copied unchanged from Linux may retain that comment format. +* Python code shall conform to `PEP8 (Style Guide for Python Code) + `_. Use `pylint + `_ for checking the code. + * Use patman to send your patches (``tools/patman/patman -H`` for full instructions). With a few tags in your commits this will check your patches and take care of emailing them. @@ -67,6 +71,9 @@ documentation is strongly advised. The Linux kernel `kernel-doc `_ documentation applies with no changes. +Our Python code documentation follows `PEP257 (Docstring Conventions) +`_. + Use structures for I/O access ----------------------------- -- 2.7.4