[Python-bugs-list] [ python-Bugs-831969 ] Docstring for pyclbr.readmodule() is incorrect

SourceForge.net noreply at sourceforge.net
Sun Nov 2 11:39:09 EST 2003


Bugs item #831969, was opened at 2003-10-28 22:48
Message generated for change (Comment added) made by aleax
You can respond by visiting: 
https://sourceforge.net/tracker/?func=detail&atid=105470&aid=831969&group_id=5470

Category: Documentation
Group: Python 2.3
>Status: Closed
>Resolution: Rejected
Priority: 5
Submitted By: Jeff Grimmett (grimmtooth)
>Assigned to: Alex Martelli (aleax)
Summary: Docstring for pyclbr.readmodule() is incorrect

Initial Comment:
Review of source code for pyclbr.readmodule() reveals 
the following:

'''Backwards compatible interface.

Call readmodule_ex() and then only keep Class objects 
from the
resulting dictionary.'''

However, the function actually calls pyclbr._readmodule
():

    dict = _readmodule(module, path)

(around line 81 of pyclbr.py)

It *appears* that the code is good and that the 
docstring just needs adjusted.

(py v. 2.3.1, Win2K 5.00.2195)


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

>Comment By: Alex Martelli (aleax)
Date: 2003-11-02 17:39

Message:
Logged In: YES 
user_id=60314

The docstring correctly describes the _effects_ of function readmodule in terms of documented function readmodule_ex.  The existence of function _readmodule to which both functions readmodule and readmodule_ex delegate their jobs is an implementation detail and as such it is not a bug that it's not explained in the docstring of function readmodule.

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

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



More information about the Python-bugs-list mailing list