* [dpdk-dev] [PATCH v2] doc: add pep8 as the python code style guidelines
@ 2016-05-27 14:57 John McNamara
2016-06-03 10:51 ` Bruce Richardson
0 siblings, 1 reply; 3+ messages in thread
From: John McNamara @ 2016-05-27 14:57 UTC (permalink / raw)
To: dev; +Cc: John McNamara
Added PEP8 to the DPDK Coding Style guidelines to cover Python
contributions to DPDK.
Signed-off-by: John McNamara <john.mcnamara@intel.com>
---
v2: fixed section level.
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..1eb67f3 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.
--
2.5.0
^ permalink raw reply [flat|nested] 3+ messages in thread* Re: [dpdk-dev] [PATCH v2] doc: add pep8 as the python code style guidelines
2016-05-27 14:57 [dpdk-dev] [PATCH v2] doc: add pep8 as the python code style guidelines John McNamara
@ 2016-06-03 10:51 ` Bruce Richardson
2016-06-07 7:53 ` Thomas Monjalon
0 siblings, 1 reply; 3+ messages in thread
From: Bruce Richardson @ 2016-06-03 10:51 UTC (permalink / raw)
To: John McNamara; +Cc: dev
On Fri, May 27, 2016 at 03:57:15PM +0100, John McNamara wrote:
> Added PEP8 to the DPDK Coding Style guidelines to cover Python
> contributions to DPDK.
>
> Signed-off-by: John McNamara <john.mcnamara@intel.com>
> ---
> v2: fixed section level.
>
>
> 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..1eb67f3 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.
> --
Yep, I think this would be good to have, especially since there is a nice
public tool to help ensure people are compliant with this. Even though all
existing code is not (yet) compliant no reason new code shouldn't be.
Acked-by: Bruce Richardson <bruce.richardson@intel.com>
^ permalink raw reply [flat|nested] 3+ messages in thread
* Re: [dpdk-dev] [PATCH v2] doc: add pep8 as the python code style guidelines
2016-06-03 10:51 ` Bruce Richardson
@ 2016-06-07 7:53 ` Thomas Monjalon
0 siblings, 0 replies; 3+ messages in thread
From: Thomas Monjalon @ 2016-06-07 7:53 UTC (permalink / raw)
To: John McNamara; +Cc: dev, Bruce Richardson
2016-06-03 11:51, Bruce Richardson:
> On Fri, May 27, 2016 at 03:57:15PM +0100, John McNamara wrote:
> > Added PEP8 to the DPDK Coding Style guidelines to cover Python
> > contributions to DPDK.
> >
> > Signed-off-by: John McNamara <john.mcnamara@intel.com>
> Acked-by: Bruce Richardson <bruce.richardson@intel.com>
Applied, thanks
^ permalink raw reply [flat|nested] 3+ messages in thread
end of thread, other threads:[~2016-06-07 7:53 UTC | newest]
Thread overview: 3+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2016-05-27 14:57 [dpdk-dev] [PATCH v2] doc: add pep8 as the python code style guidelines John McNamara
2016-06-03 10:51 ` Bruce Richardson
2016-06-07 7:53 ` Thomas Monjalon
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).