Coding style: docstring inconsistency with pep8 and pep257
|Reported by:||anonymous||Owned by:||nobody|
|Severity:||Keywords:||pep257 coding style|
|Has patch:||no||Needs documentation:||no|
|Needs tests:||no||Patch needs improvement:||no|
PEP257 advises a docstring as "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 ..."."
PEP8 also mentions PEP257 and gives example """Return a foobang [...]
But Django Coding Style advises to use exactly the opposite in http://www.djangoproject.com/documentation/contributing/#coding-style .
If this is unadvertedly, we should go for the PEP257 convention; if this is by intent, someone who knows it should add the reason for not following the PEP247 convention.