diff mbox

[dpdk-dev,v1] doc: add pep8 as the python code style guidelines

Message ID 1464360642-2695-1-git-send-email-john.mcnamara@intel.com (mailing list archive)
State Superseded, archived
Headers

Commit Message

John McNamara May 27, 2016, 2:50 p.m. UTC 
  Added PEP8 to the DPDK Coding Style guidelines to cover Python
contributions to DPDK.

Signed-off-by: John McNamara <john.mcnamara@intel.com>
---
 doc/guides/contributing/coding_style.rst | 8 ++++++++
 1 file changed, 8 insertions(+)

Comments

John McNamara May 27, 2016, 2:56 p.m. UTC | #1 
> -----Original Message-----
> From: Mcnamara, John
> Sent: Friday, May 27, 2016 3:51 PM
> To: dev@dpdk.org
> Cc: Mcnamara, John <john.mcnamara@intel.com>
> Subject: [PATCH v1] doc: add pep8 as the python code style guidelines
> 
> Added PEP8 to the DPDK Coding Style guidelines to cover Python
> contributions to DPDK.
> 
> Signed-off-by: John McNamara <john.mcnamara@intel.com>
> ---
>  doc/guides/contributing/coding_style.rst | 8 ++++++++
>  1 file changed, 8 insertions(+)
> 
> diff --git a/doc/guides/contributing/coding_style.rst
> b/doc/guides/contributing/coding_style.rst
> index ad1392d..df64aad 100644
> --- a/doc/guides/contributing/coding_style.rst
> +++ b/doc/guides/contributing/coding_style.rst
> @@ -685,3 +685,11 @@ Control Statements
>                   usage();
>                   /* NOTREACHED */
>           }
> +
> +
> +Python Code
> +~~~~~~~~~~~

Self-nack. Wrong section level.
diff mbox

Patch

diff --git a/doc/guides/contributing/coding_style.rst b/doc/guides/contributing/coding_style.rst
index ad1392d..df64aad 100644
--- a/doc/guides/contributing/coding_style.rst
+++ b/doc/guides/contributing/coding_style.rst
@@ -685,3 +685,11 @@  Control Statements
                  usage();
                  /* NOTREACHED */
          }
+
+
+Python Code
+~~~~~~~~~~~
+
+All python code should be compliant with `PEP8 (Style Guide for Python Code) <https://www.python.org/dev/peps/pep-0008/>`_.
+
+The `pep8` tool can be used for testing compliance with the guidelines.