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: docs for 'profile' should refer to pstats.Stats
Type: Stage:
Components: Documentation Versions: Python 2.5
process
Status: closed Resolution: fixed
Dependencies: Superseder:
Assigned To: Nosy List: georg.brandl, oripel
Priority: normal Keywords:

Created on 2006-05-06 12:54 by oripel, last changed 2022-04-11 14:56 by admin. This issue is now closed.

Messages (3)
msg28436 - (view) Author: Ori Peleg (oripel) Date: 2006-05-06 12:54
The docs for module 'profile' refer to 'profile.Stats',
which look like:

def Stats(*args):
    print 'Report generating functions are in the
"pstats" module\a'

This is true in older Python versions, as well as 2.5a2:

http://docs.python.org/dev/lib/module-profile.html

Suggestion: have the documentation point to
pstats.Stats instead, and possibly remove the
placeholder 'Stats' in module profile, or have it raise
an exception instead of printing an error.
msg28437 - (view) Author: Ori Peleg (oripel) Date: 2006-05-06 12:57
Logged In: YES 
user_id=1131251

A correction - the docs do refer to the 'this class from the
pstats module', but this easily missed by someone skipping
carefully reading the preamble text (like me :-/ )

You could say this is PEBKAC (problem exists between
keyboard and chair), but I suggest it's a common phenomenon
meaning the pointer to module 'pstats' should be more prominent.
msg28438 - (view) Author: Georg Brandl (georg.brandl) * (Python committer) Date: 2006-05-10 15:59
Logged In: YES 
user_id=849994

I added a \note about the module change in rev. 45949.
History
Date User Action Args
2022-04-11 14:56:17adminsetgithub: 43325
2006-05-06 12:54:44oripelcreate