Terry J. Reedy added the comment:
PEP8 just says "PEP 257 describes good docstring conventions."
PEP 257 is what says '''It [the one line docstring] 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 ...". '''
I strongly prefer the rule, but we do not usually patch purely for PEP8
compliance. However, a docstring patch is safer than a code patch.
----------
nosy: +terry.reedy
stage: -> patch review
versions: -Python 3.1
_______________________________________
Python tracker <[email protected]>
<http://bugs.python.org/issue19067>
_______________________________________
_______________________________________________
Python-bugs-list mailing list
Unsubscribe:
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com
