[issue18956] Document useful functions in ‘pydoc’ module
![](https://secure.gravatar.com/avatar/fa0f7819f1825f596b384c19aa7dcf33.jpg?s=120&d=mm&r=g)
New submission from Ben Finney: 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 ---------- assignee: docs@python components: Documentation messages: 197138 nosy: bignose, docs@python priority: normal severity: normal status: open title: Document useful functions in ‘pydoc’ module type: enhancement versions: Python 2.6, Python 2.7, Python 3.1, Python 3.2, Python 3.3, Python 3.4, Python 3.5 _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue18956> _______________________________________
![](https://secure.gravatar.com/avatar/fa0f7819f1825f596b384c19aa7dcf33.jpg?s=120&d=mm&r=g)
Berker Peksag added the comment: 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. ---------- nosy: +berker.peksag versions: -Python 2.6, Python 3.1, Python 3.2, Python 3.5 _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue18956> _______________________________________
![](https://secure.gravatar.com/avatar/fa0f7819f1825f596b384c19aa7dcf33.jpg?s=120&d=mm&r=g)
Changes by Martin Panter <vadmium+py@gmail.com>: ---------- nosy: +vadmium _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue18956> _______________________________________
![](https://secure.gravatar.com/avatar/fa0f7819f1825f596b384c19aa7dcf33.jpg?s=120&d=mm&r=g)
Changes by Berker Peksag <berker.peksag@gmail.com>: ---------- resolution: -> duplicate stage: -> resolved status: open -> closed superseder: -> Make generally useful pydoc functions public _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue18956> _______________________________________
participants (3)
-
Ben Finney
-
Berker Peksag
-
Martin Panter