Author ezio.melotti
Recipients dlam, docs@python, eli.bendersky, ezio.melotti, serhiy.storchaka, tshepang
Date 2013-01-24.18:02:10
SpamBayes Score -1.0
Marked as misclassified Yes
Message-id <1359050530.62.0.55713537329.issue16954@psf.upfronthosting.co.za>
In-reply-to
Content
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").
History
Date User Action Args
2013-01-24 18:02:10ezio.melottisetrecipients: + ezio.melotti, eli.bendersky, docs@python, tshepang, dlam, serhiy.storchaka
2013-01-24 18:02:10ezio.melottisetmessageid: <1359050530.62.0.55713537329.issue16954@psf.upfronthosting.co.za>
2013-01-24 18:02:10ezio.melottilinkissue16954 messages
2013-01-24 18:02:10ezio.melotticreate