imperative mood in docstrings

Jussi Piitulainen jpiitula at ling.helsinki.fi
Sun Feb 9 18:21:47 CET 2014


Mark Lawrence writes:
> 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?
> 
> I can't really answer your question as I don't understand why
> docstrings should get moody, or did you mean mode? :)

<http://en.wikipedia.org/wiki/Grammatical_mood>



More information about the Python-list mailing list