[docs] [issue18956] Document useful functions in ‘pydoc’ module

Ben Finney report at bugs.python.org
Sat Sep 7 07:38:56 CEST 2013

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 at python
components: Documentation
messages: 197138
nosy: bignose, docs at 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 at bugs.python.org>

More information about the docs mailing list