imperative mood in docstrings

Mark Lawrence breamoreboy at
Sun Feb 9 18:15:46 CET 2014

On 09/02/2014 12:05, bagrat lazaryan wrote:
> pep 257 -- docstring conventions, as well as a myriad of books and other resources, recommend documenting a function's or method's effect as a command ("do this", "return that"), not as a description ("does this", "returns that"). what's the logic behind this recommendation?
> bagratte

I can't really answer your question as I don't understand why docstrings 
should get moody, or did you mean mode? :)

My fellow Pythonistas, ask not what our language can do for you, ask 
what you can do for our language.

Mark Lawrence

This email is free from viruses and malware because avast! Antivirus protection is active.

More information about the Python-list mailing list