]> git.dujemihanovic.xyz Git - u-boot.git/commitdiff
doc: codingstyle: Python coding style
authorHeinrich Schuchardt <heinrich.schuchardt@canonical.com>
Wed, 19 Apr 2023 06:45:34 +0000 (08:45 +0200)
committerHeinrich Schuchardt <heinrich.schuchardt@canonical.com>
Fri, 21 Apr 2023 06:50:35 +0000 (08:50 +0200)
Indicate that we follow PEP8 and PEP257.

Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
Reviewed-by: Simon Glass <sjg@chromium.org>
doc/develop/codingstyle.rst

index 1d5d0192b3e27354f18a45868daa1244d87711f7..3d05a6b988757b1fd3c5f7e9e7118c3d23df6129 100644 (file)
@@ -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)
+  <https://peps.python.org/pep-0008/>`_. Use `pylint
+  <https://github.com/pylint-dev/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
 <https://www.kernel.org/doc/html/latest/doc-guide/kernel-doc.html>`_
 documentation applies with no changes.
 
+Our Python code documentation follows `PEP257 (Docstring Conventions)
+<https://peps.python.org/pep-0257/>`_.
+
 Use structures for I/O access
 -----------------------------