RE: imperative mood in docstrings

2014-02-13 Thread bagrat lazaryan
thank you all! bagratte -- https://mail.python.org/mailman/listinfo/python-list

imperative mood in docstrings

2014-02-09 Thread bagrat lazaryan
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 -- https