[Buildroot] [PATCHv2 buildroot-test 02/11] autobuild-run: convert regular function comments into docstrings

Thomas Petazzoni thomas.petazzoni at free-electrons.com
Sun Oct 19 21:01:32 UTC 2014


Dear Thomas De Schampheleire,

On Sun, 19 Oct 2014 21:29:58 +0200, Thomas De Schampheleire wrote:
> From: Thomas De Schampheleire <thomas.de.schampheleire at gmail.com>
> 
> Documenting a function in Python is done with docstrings, rather than
> with comments above the function. The conventions are described in
> PEP257: http://legacy.python.org/dev/peps/pep-0257/
> 
> Signed-off-by: Thomas De Schampheleire <thomas.de.schampheleire at gmail.com>
> ---
> v2: rebase after reordering

Even though I find regular comments easier to read, let's use the
Pythonist way of documenting stuff. Patch applied, thanks!

Thomas
-- 
Thomas Petazzoni, CTO, Free Electrons
Embedded Linux, Kernel and Android engineering
http://free-electrons.com



More information about the buildroot mailing list