imperative mood in docstrings

bagrat lazaryan bagratte at live.com
Sun Feb 9 13:05:59 CET 2014


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




More information about the Python-list mailing list