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").
----------
_______________________________________
Python tracker <[email protected]>
<http://bugs.python.org/issue16954>
_______________________________________
_______________________________________________
Python-bugs-list mailing list
Unsubscribe:
http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com
