[gentoo-catalyst] docstring standard

[gentoo-catalyst] docstring standard

[Mike Frysinger]

[-- Attachment #1: Type: text/plain, Size: 396 bytes --]

would be good to dictate now considering docstring coverage is so low.
personally i find the javadoc style to be unreadable and unpythonic ;),
so i'd propose the style clearly documented here:
	https://google-styleguide.googlecode.com/svn/trunk/pyguide.html?showone=Comments#Comments

i find it much easier to read at a glance.  i've also written a pylint
module that checks its syntax :).
-mike

[-- Attachment #2: Digital signature --]
[-- Type: application/pgp-signature, Size: 819 bytes --]

Re: [gentoo-catalyst] docstring standard

[Brian Dolbec]

On Tue, 6 Oct 2015 11:21:10 -0400
Mike Frysinger <vapier@gentoo.org> wrote:

> would be good to dictate now considering docstring coverage is so low.
> personally i find the javadoc style to be unreadable and
> unpythonic ;), so i'd propose the style clearly documented here:
> 	https://google-styleguide.googlecode.com/svn/trunk/pyguide.html?showone=Comments#Comments
> 
> i find it much easier to read at a glance.  i've also written a pylint
> module that checks its syntax :).
> -mike

It looks nice, but is yet another style to learn for me (minor).
I have used the portage style in some new code, but the vast majority
of the code is without much of any good docstrings.  So, yeah, now is
the time to decide, before it gets more difficult to change.

I'd like to hear from the others in releng.

-- 
Brian Dolbec <dolsen>