diff options
| author | Heinrich Schuchardt | 2023-04-19 08:45:34 +0200 |
|---|---|---|
| committer | Heinrich Schuchardt | 2023-04-21 08:50:35 +0200 |
| commit | 8626ef32e9443353d40ec44d4a0c69deac011efb (patch) | |
| tree | 638eeb603f05009ee8cbffb0064a91be55ccccda /doc/develop | |
| parent | 5db4972a5bbdbf9e3af48ffc9bc4fec73b7b6a79 (diff) | |
doc: codingstyle: Python coding style
Indicate that we follow PEP8 and PEP257.
Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
Reviewed-by: Simon Glass <sjg@chromium.org>
Diffstat (limited to 'doc/develop')
| -rw-r--r-- | doc/develop/codingstyle.rst | 7 |
1 files changed, 7 insertions, 0 deletions
diff --git a/doc/develop/codingstyle.rst b/doc/develop/codingstyle.rst index 1d5d0192b3e..3d05a6b9887 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) + <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 ----------------------------- |