Author eli.bendersky
Recipients dlam, docs@python, eli.bendersky, ezio.melotti, serhiy.storchaka, tshepang
Date 2013-01-24.18:15:10
SpamBayes Score -1.0
Marked as misclassified Yes
Message-id <CAF-Rda-KnaaGUScjHunZKwgDGer=9hDf3rRHA0qYyXTeRCtT1g@mail.gmail.com>
In-reply-to <1359050530.62.0.55713537329.issue16954@psf.upfronthosting.co.za>
Content
On Thu, Jan 24, 2013 at 10:02 AM, Ezio Melotti <report@bugs.python.org>wrote:

>
> Ezio Melotti added the comment:
>
> I would suggest to adapt the comments to follow PEP 257, and in particular:
> """
> The docstring is a phrase ending in a period. It prescribes the function
> or method's effect as a command ("Do this", "Return that"), not as a
> description; e.g. don't write "Returns the pathname ...".
> """
>
> Currently there are two docstrings, one for write() and one for
> iterparse() (recently added in #9708).  Only the former uses the correct
> form ("Return" instead of "Returns").
>

Actually, the latter was copy-pasted from the ReST docs of the method. Does
that PEP 257 suggestion apply to ReST docs as well, or do we have a
discrepancy?
History
Date User Action Args
2013-01-24 18:15:11eli.benderskysetrecipients: + eli.bendersky, ezio.melotti, docs@python, tshepang, dlam, serhiy.storchaka
2013-01-24 18:15:11eli.benderskylinkissue16954 messages
2013-01-24 18:15:10eli.benderskycreate