[ python-Bugs-843385 ] help(obj) should use __doc__ when available

[SourceForge.net]

Bugs item #843385, was opened at 2003-11-16 15:05
Message generated for change (Tracker Item Submitted) made by Item Submitter
You can respond by visiting: 
https://sourceforge.net/tracker/?func=detail&atid=105470&aid=843385&group_id=5470

Category: Python Library
Group: Feature Request
Status: Open
Resolution: None
Priority: 5
Submitted By: Robert Kern (kern)
Assigned to: Nobody/Anonymous (nobody)
Summary: help(obj) should use __doc__ when available

Initial Comment:
Suppose one makes a C extension type that is callable and has a 
__doc__ attribute. Currently, calling help() on the object yields 
something like the following: 
 
>>> help(scipy.linalg._flinalg.slu_c) 
Help on fortran: 
 
<fortran object> 
>>> hasattr(scipy.linalg._flinalg.slu_c, '__doc__') 
True 
>>> 
 
help() could give more useful information by modifying 
pydoc.TextDoc.docother to check for a __doc__ attribute and add it 
(just as docother checks for the 'doc' keyword). 

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

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