David Goodger writes:
> Even if there were no supporting tools, I think it is useful to
> express the intent of a class/method/function in a single line. The
> process of distilling the description down can, in itself, be
> illuminating. To imitate the Zen: if the code can't be described in a
> s
Jeremy Hylton wrote:
A question came up at work about docstring formatting. It relates to
the description of the summary line in PEP 257.
http://www.python.org/dev/peps/pep-0257/
"""Multi-line docstrings consist of a summary line just like a
one-line docstring, followed by a blank line, follo
On Thu, May 28, 2009 at 09:06:03AM -0400, Jeremy Hylton wrote:
> It says that the summary line may be used by automatic indexing tools,
> but is there any evidence that such a tool actually exists?
epydoc, for one.
Oleg.
--
Oleg Broytmannhttp://phd.pp.ru/p...@phd.
On Thu, May 28, 2009 at 09:06, Jeremy Hylton wrote:
> A question came up at work about docstring formatting. It relates to
> the description of the summary line in PEP 257.
>
> http://www.python.org/dev/peps/pep-0257/
> """Multi-line docstrings consist of a summary line just like a
> one-line doc
On 01:06 pm, jer...@alum.mit.edu wrote:
It says that the summary line may be used by automatic indexing tools,
but is there any evidence that such a tool actually exists? Or was
there once upon a time? If there are no such tools, do we still think
that it is important that it fits on line line
A question came up at work about docstring formatting. It relates to
the description of the summary line in PEP 257.
http://www.python.org/dev/peps/pep-0257/
"""Multi-line docstrings consist of a summary line just like a
one-line docstring, followed by a blank line, followed by a more
elaborate d
