[Python-bugs-list] [ python-Feature Requests-606733 ] Docstring formatter.

[SourceForge.net]

Feature Requests item #606733, was opened at 2002-09-09 08:58
Message generated for change (Comment added) made by rhettinger
You can respond by visiting: 
https://sourceforge.net/tracker/?func=detail&atid=355470&aid=606733&group_id=5470

Category: Python Library
Group: None
Status: Open
Resolution: None
Priority: 5
Submitted By: Allan Crooks (amc1)
Assigned to: Nobody/Anonymous (nobody)
Summary: Docstring formatter.

Initial Comment:
I think the code that pydoc uses to format docstrings 
(which is located in inspect.getdoc) should be exposed, 
so that you can in some way pass docstrings directly to 
be formatted, rather than "wrapping" them as a __doc__ 
attribute on a temporary object.

----------------------------------------------------------------------

>Comment By: Raymond Hettinger (rhettinger)
Date: 2003-06-28 01:51

Message:
Logged In: YES 
user_id=80475

The hassle of wrapping a __doc__ attribute is small and the 
use case is rare enough that there isn't much of a case for 
changing the module API.

Also, I'm concerned about module cohesion.  The purpose of 
the module is inspecting live objects.  Minor tweaking of 
docstring formatting is only a by-product and not a primary 
function.




----------------------------------------------------------------------

You can respond by visiting: 
https://sourceforge.net/tracker/?func=detail&atid=355470&aid=606733&group_id=5470