#11 __docformat__ for entire packages

closed
Edward Loper
Inspection (9)
5
2004-04-24
2004-04-02
No

I'd really like to be able to note in a package that
the docstrings are in reStructuredText, and have that
apply to an entire package (and preferably for
subpackages that don't override it). Perhaps a
__docformat__ in __init__.py could be treated as
applying to the entire package or hierarchy (and
__docformat__ in a module overrides the package setting).

It would also be nice if the module named as a starting
point could have a __doctitle__ that's equivalent to
the --name command line option.

Discussion

  • Edward Loper
    Edward Loper
    2004-04-24

    • labels: --> Inspection
    • assigned_to: nobody --> edloper
    • status: open --> closed
     
  • Edward Loper
    Edward Loper
    2004-04-24

    Logged In: YES
    user_id=195958

    I floated this idea on python-dev, and Guido said he'd
    rather each module get its own __docformat__. [1] So
    things will stay as they are.

    I moved the __doctitle__ request to its own RFE
    (#941140), so I could close this one.

    [1] http://mail.python.org/pipermail/python-dev/2004-
    April/044550.html