➜

This issue tracker has been migrated to GitHub, and is currently read-only.
For more information, see the GitHub FAQs in the Python's Developer Guide.

classification
Title: Docstring for pyclbr.readmodule() is incorrect
Type: Stage:
Components: Documentation Versions: Python 2.3
process
Status: closed Resolution: rejected
Dependencies: Superseder:
Assigned To: aleax Nosy List: aleax, grimmtooth
Priority: normal Keywords:

Created on 2003-10-28 21:48 by grimmtooth, last changed 2022-04-11 14:56 by admin. This issue is now closed.

Messages (2)
msg18788 - (view) Author: Jeff Grimmett (grimmtooth) Date: 2003-10-28 21:48 
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)
msg18789 - (view) Author: Alex Martelli (aleax) * (Python committer) Date: 2003-11-02 16:39 
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.
History
Date User Action Args
2022-04-11 14:56:00adminsetgithub: 39468
2003-10-28 21:48:46grimmtoothcreate