[Doc-SIG] epydoc reST markup for stdlib docstrings

Ralf Gommers ralf.gommers at googlemail.com
Thu Apr 15 12:39:05 CEST 2010

On Wed, Apr 14, 2010 at 11:43 PM, Barry Warsaw <barry at python.org> wrote:

> On Apr 14, 2010, at 11:13 PM, Ralf Gommers wrote:
> >You're a core developer (I think). But for the *average* user, do you
> really
> >think tags are fine? Earlier in this thread there was a mention of people
> >that love to read XML. I'm exaggerating a bit of course, but this is
> >similar. Whitespace beats tags for readability.
> Well, I would think that help output, whether in a terminal or online would
> use the raw text to do a nicer job of formatting.

If it looks good in help() (and ipython) then I have no problem with it. You
would have to preprocess each docstring each time it's viewed though,
instead of only when generating html docs. But if it's robust, then sure,
it's a non-issue.

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.python.org/pipermail/doc-sig/attachments/20100415/2541e875/attachment.html>

More information about the Doc-SIG mailing list