Message180536
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"). |
|
Date |
User |
Action |
Args |
2013-01-24 18:02:10 | ezio.melotti | set | recipients:
+ ezio.melotti, eli.bendersky, docs@python, tshepang, dlam, serhiy.storchaka |
2013-01-24 18:02:10 | ezio.melotti | set | messageid: <1359050530.62.0.55713537329.issue16954@psf.upfronthosting.co.za> |
2013-01-24 18:02:10 | ezio.melotti | link | issue16954 messages |
2013-01-24 18:02:10 | ezio.melotti | create | |
|