[ python-Bugs-1482988 ] docs for 'profile' should refer to pstats.Stats

[SourceForge.net]

Bugs item #1482988, was opened at 2006-05-06 12:54
Message generated for change (Comment added) made by gbrandl
You can respond by visiting: 
https://sourceforge.net/tracker/?func=detail&atid=105470&aid=1482988&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: Documentation
Group: Python 2.5
>Status: Closed
>Resolution: Fixed
Priority: 5
Submitted By: Ori Peleg (oripel)
Assigned to: Nobody/Anonymous (nobody)
Summary: docs for 'profile' should refer to pstats.Stats

Initial Comment:
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.


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

>Comment By: Georg Brandl (gbrandl)
Date: 2006-05-10 15:59

Message:
Logged In: YES 
user_id=849994

I added a \note about the module change in rev. 45949.

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

Comment By: Ori Peleg (oripel)
Date: 2006-05-06 12:57

Message:
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.

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

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