From: Brian Dolbec <dolsen@gentoo.org>
To: gentoo-catalyst@lists.gentoo.org
Subject: Re: [gentoo-catalyst] docstring standard
Date: Tue, 6 Oct 2015 08:39:53 -0700 [thread overview]
Message-ID: <20151006083953.1a5b9da2.dolsen@gentoo.org> (raw)
In-Reply-To: <20151006152110.GL6518@vapier.lan>
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>
prev parent reply other threads:[~2015-10-06 15:40 UTC|newest]
Thread overview: 2+ messages / expand[flat|nested] mbox.gz Atom feed top
2015-10-06 15:21 [gentoo-catalyst] docstring standard Mike Frysinger
2015-10-06 15:39 ` Brian Dolbec [this message]
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20151006083953.1a5b9da2.dolsen@gentoo.org \
--to=dolsen@gentoo.org \
--cc=gentoo-catalyst@lists.gentoo.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox