[New-bugs-announce] [issue3196] Option in pydoc to show docs from private methods

[Morten Lied Johansen]

New submission from Morten Lied Johansen <mortenjo at ifi.uio.no>:

Currently, running pydoc on a module will show you the documentation on 
all regular methods, and all special methods (starting and ending in 
double underscores).

Private methods (starting with a single underscore) are not included.

Some times, it would be nice to include docs for these methods aswell, 
and a small change to pydoc.visiblename solves the problem.

I've included a patch that adds this behaviour as an option (-i for 
include private names). The implementation isn't as clean as one would 
hope for (sets a global flag), but was the best I could come up with in 
the short time I had available. Feel free to make a better 
implementation.

The patch is against python 2.5.

----------
components: Library (Lib)
files: pydoc.privatenames.patch
keywords: patch
messages: 68722
nosy: mortenlj
severity: normal
status: open
title: Option in pydoc to show docs from private methods
type: feature request
versions: Python 2.5
Added file: http://bugs.python.org/file10727/pydoc.privatenames.patch

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue3196>
_______________________________________