[Python-Dev] query: docstring formatting in python distutils code
Fred Drake
fdrake at acm.org
Thu Jul 8 23:41:52 CEST 2010
On Thu, Jul 8, 2010 at 5:21 PM, Georg Brandl <g.brandl at gmx.net> wrote:
> Problem is, in the case of help() we have no way of knowing whether the
> given __doc__ string is supposed to be (mini)reST. Of course, reverting
> to showing the plain content on parsing errors is one possibility, but
> I can still imagine instances where something is successfully interpreted
> as reST, but intended to be read and understood verbatim by the author.
The docstring processing PEP provides for this:
http://www.python.org/dev/peps/pep-0258/#id42
-Fred
--
Fred L. Drake, Jr. <fdrake at gmail.com>
"A storm broke loose in my mind." --Albert Einstein
More information about the Python-Dev
mailing list