[Doc-SIG] docstring grammar

Robin Friedrich friedrich@pythonpros.com
Mon, 29 Nov 1999 13:44:23 -0600


Contains an old summary of the formatting rules for Structured Text use in
doc strings.

Oddly Dan's subscription to this list is disabled, probably from an old
address. The latest address I have for him is Daniel.Larsson@telia.com

----- Original Message -----
From: David Ascher <da@ski.org>
To: Robin Friedrich <friedrich@pythonpros.com>
Cc: <doc-sig@python.org>; Daniel Larsson
Sent: Monday, November 29, 1999 1:22 PM
Subject: Re: [Doc-SIG] docstring grammar

> On Mon, 29 Nov 1999, Robin Friedrich wrote:
> > Some people on this list should remember the development days of gendoc
> > it's cleaner successor pythondoc written by Dan Larsson (gosh I hope I'm
> > the only one)!
> Yes, I remember it.  Thanks for the reminder and pointer, Robin!
> > We pleaded back then for ideas/opinions/hacked code to help improve the
> > working code Dan wrote but got little response.
> FWIW, I think that one problem gendoc/pythondoc had in terms of strategy
> was that it was billed as a 'tool'.  I think that if we establish a
> 'blessed standard' then any standard-compliant tool has a guaranteed user
> base, and has a far greater likelihood of long-term success.  Also, once
> the format is documented, then folks who don't like gendoc or for whatever
> reason want to do it 'their own way' can still do it in a compatible way.
> I'll start digging in gendoc to see the differences between its format and
> what I've been discussing.  I'd love to leverage it to build a reference
> implementation.
> Dan Larsson, are you reading this discussion?  We could use your
> experience here!
> --david