Issue 18956: Document useful functions in ‘pydoc’ module (original) (raw)

Issue18956

Created on 2013-09-07 05:38 by bignose, last changed 2022-04-11 14:57 by admin. This issue is now closed.

Messages (2)
msg197138 - (view)	Author: Ben Finney (bignose)	Date: 2013-09-07 05:38
The library documentation for ‘pydoc’ expects that the ‘pydoc’ module will only ever be run as a command-line program. This ignores the general usefulness of several of the functions in that module when imported from the library. The documentation should describe at least the following functions: * pydoc.getdoc * pydoc.synopsis * pydoc.splitdoc The following would be useful also: * pydoc.classname * pydoc.cram * pydoc.allmethods
msg197139 - (view)	Author: Berker Peksag (berker.peksag) *	Date: 2013-09-07 05:58
Looks like duplicate of issue 7798. > * pydoc.getdoc http://docs.python.org/3.4/library/inspect.html#inspect.getdoc > * pydoc.splitdoc See issue 12916 for inspect.splitdoc. > * pydoc.cram This was rejected in issue 12914. > * pydoc.allmethods This was rejected in issue 12917.