Message198547
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. |
|
Date |
User |
Action |
Args |
2013-09-28 20:17:15 | terry.reedy | set | recipients:
+ terry.reedy, docs@python, tshepang, marco.buttu |
2013-09-28 20:17:15 | terry.reedy | set | messageid: <1380399435.24.0.0934445577978.issue19067@psf.upfronthosting.co.za> |
2013-09-28 20:17:15 | terry.reedy | link | issue19067 messages |
2013-09-28 20:17:15 | terry.reedy | create | |
|