[Python-Dev] query: docstring formatting in python distutils code

Fred Drake fdrake at acm.org
Fri Jul 9 14:35:11 CEST 2010


On Fri, Jul 9, 2010 at 2:51 AM, Georg Brandl <g.brandl at gmx.net> wrote:
> Yes, but[tm] it is not always easy to find the correct module to look for
> __docformat__ when given an object.

True.  That PEP was written before decorators were common, in
particular.  That's changed the landscape in substantial ways.

It may be that at this point, there's no good way to deal with
formatting in docstrings at anything other than the project level,
where policies for the code can be set if desired.

Ideally, the format of a docstring would be captured along with the
docstring itself.


  -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