Docstring formatter.

[amc1]

BPO	606733
Nosy	@rhettinger

^{Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.}

Show more details

GitHub fields:

assignee = None
closed_at = <Date 2008-01-29.21:10:03.813>
created_at = <Date 2002-09-09.13:58:19.000>
labels = ['type-feature', 'library']
title = 'Docstring formatter.'
updated_at = <Date 2008-01-29.21:10:03.812>
user = 'https://bugs.python.org/amc1'

bugs.python.org fields:

activity = <Date 2008-01-29.21:10:03.812>
actor = 'draghuram'
assignee = 'none'
closed = True
closed_date = <Date 2008-01-29.21:10:03.813>
closer = 'draghuram'
components = ['Library (Lib)']
creation = <Date 2002-09-09.13:58:19.000>
creator = 'amc1'
dependencies = []
files = []
hgrepos = []
issue_num = 606733
keywords = []
message_count = 2.0
messages = ['61096', '61097']
nosy_count = 2.0
nosy_names = ['amc1', 'rhettinger']
pr_nums = []
priority = 'normal'
resolution = 'rejected'
stage = None
status = 'closed'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue606733'
versions = []

[amc1]

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.

[rhettinger]

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.