[ python-Bugs-1217881 ] pydoc includes unnecessary files for a package.

[SourceForge.net]

Bugs item #1217881, was opened at 2005-06-09 19:38
Message generated for change (Tracker Item Submitted) made by Item Submitter
You can respond by visiting: 
https://sourceforge.net/tracker/?func=detail&atid=105470&aid=1217881&group_id=5470

Please note that this message will contain a full copy of the comment thread,
including the initial issue submission, for this request,
not just the latest update.
Category: Extension Modules
Group: Python 2.4
Status: Open
Resolution: None
Priority: 5
Submitted By: Igor Belyi (belyi)
Assigned to: Nobody/Anonymous (nobody)
Summary: pydoc includes unnecessary files for a package.

Initial Comment:
PyDoc lists all files present in a package directory in
a "Package Contents" table instead of only the ones
listed in __all__ variable in __init__.py file.

This is very inconvenient for packages which are
wrappers for some C library since the shared library
and a Wrapper get the reference on the package page but
then they do not have any comments and their pages are
not generated. As a result package page has those
annoying dead links.

One can probably fix this by creating a special dummy
pages for those unused files but it's an agly solution.
I do believe that using __all__ variable from
__init__.py file when it is defined is more appropriate
way to know what files represent the contents of the
package.

Cheers,
Igor


----------------------------------------------------------------------

You can respond by visiting: 
https://sourceforge.net/tracker/?func=detail&atid=105470&aid=1217881&group_id=5470