On 2/9/2014 7:05 AM, 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?
The imperative is directed at the Python interpreter. It says what a
call instructs the interpreter to do.
--
Terry Jan Reedy
--
https://mail.python.org/mailman/listinfo/python-list