Kal Sze wrote:
Hello,
PEP 257 says that docstrings should be written in a prescriptive way (i.e.
using the imperative mood) instead of a descriptive way (indicative mood).
PEP 257: http://www.python.org/dev/peps/pep-0257/
For those who don't know English grammatical terms, here are some examp
On 11/05/12 04:41, Kal Sze wrote:
PEP 257 says that docstrings should be written in a prescriptive way
(i.e. using the imperative mood) instead of a descriptive way
(indicative mood). This seems like a rather odd recommendation. Since
the docstring is supposed to tell the programmer *how* to use
Hello,
PEP 257 says that docstrings should be written in a prescriptive way (i.e.
using the imperative mood) instead of a descriptive way (indicative mood).
This seems like a rather odd recommendation. Since the docstring is
supposed to tell the programmer *how* to use a function/method, I've alwa
