[issue7798] Make generally useful pydoc functions public

Terry J. Reedy report at bugs.python.org
Wed Mar 9 03:38:24 CET 2011

Terry J. Reedy <tjreedy at udel.edu> added the comment:

I have looked at the pydoc module.  Everything except help() is intended to be private. The author says within the file that __all__, when present, defines public interface and uses that definition within help() to decide what to display. So I do not think anything else should be documented unless it is made 'public' by being added to pydoc.__all__ or moved to another module. In either case, the result would be a new code feature. Doc addition would naturally follow. Also, if a function is made public, the interface and code could be reconsidered for possible modification for general usage.

assignee:  -> docs at python
components: +Library (Lib)
nosy: +docs at python
title: document pydoc methods -> Make generally useful pydoc functions public
versions: +Python 3.3 -Python 2.7, Python 3.1, Python 3.2

Python tracker <report at bugs.python.org>

More information about the Python-bugs-list mailing list