durusmail: quixote-users: pydoc for quixote
pydoc for quixote
2003-10-21
2003-10-21
2003-10-21
2003-10-21
Re: pydoc for quixote
2003-10-22
2003-10-22
2003-10-27
pydoc for quixote
amk@amk.ca
2003-10-21
On Tue, Oct 21, 2003 at 09:02:46AM -0400, David Binger wrote:
> The fact that we don't have convenient template docstrings is annoying
> though, and seems like another problem worth solving.

But how could it be solved?  Early on various alternatives were suggested:

1) No docstrings, unless you do foo.__doc__ = '...'.
2) The first string is always a docstring.  (Introducing that now
   would break existing templates.)
3) Guess if the first string is a docstring or not.  (Eek!)
4) Mark docstrings specially: d"docstring", or something like that.

1 is the only appealing option; at least it's simple to explain,
and errors are obvious -- if you add a docstring, you'll see its text in
your output and immediately figure out the problem.

--amk

reply