[ python-Bugs-489256 ] Lib/profile.doc should be updated

[SourceForge.net]

Bugs item #489256, was opened at 2001-12-05 06:51
Message generated for change (Comment added) made by birkenfeld
You can respond by visiting: 
https://sourceforge.net/tracker/?func=detail&atid=105470&aid=489256&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: None
>Status: Closed
>Resolution: Fixed
Priority: 5
Submitted By: Anthony Baxter (anthonybaxter)
Assigned to: Johannes Gijsbers (jlgijsbers)
Summary: Lib/profile.doc should be updated

Initial Comment:
What's Lib/profile.doc doing there? Is it still needed?
Why is it in Lib, anyway?

(it seems very old - is it still up to date after all
the hackery? doesn't seem so)

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

>Comment By: Reinhold Birkenfeld (birkenfeld)
Date: 2005-12-27 00:44

Message:
Logged In: YES 
user_id=1188172

Commented out the notes about the old profiler in rev. 41826.
Closing this bug now.

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

Comment By: Johannes Gijsbers (jlgijsbers)
Date: 2005-01-10 10:07

Message:
Logged In: YES 
user_id=469548

I just checked and there was no information in profile.doc
that wasn't in the library reference, so I've removed it
now. I've also replaced help() along the lines of what you
suggested. 

Just one more question: could we remove the "How Is This
Profiler Different From The Old Profiler?" subsection from
the library reference? It's hardly relevant, considering
that the Old Profiler was last seen in Python 1.1 (!).

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

Comment By: Fred L. Drake, Jr. (fdrake)
Date: 2005-01-10 04:07

Message:
Logged In: YES 
user_id=3066

Removing profile.doc sounds fine to me.  The only thing that
really needs to be done prior to removal is to make sure all
the (still current) information in profile.doc is
represented in the library documentation.

The help() function should probably be replaced with
something that refers the user to the library documentation,
rather than removing the function.


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

Comment By: Johannes Gijsbers (jlgijsbers)
Date: 2005-01-09 02:27

Message:
Logged In: YES 
user_id=469548

I would like to go ahead with removing profile.doc and the
help() function from profile.py for Python 2.5. They're not
really all that helpful, they're in an unexpected place, and
they're undocumented.  I'll remove them if there are no
objections within some weeks. 

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

Comment By: Fred L. Drake, Jr. (fdrake)
Date: 2001-12-05 07:08

Message:
Logged In: YES 
user_id=3066

profile.doc is used as the help file for profile.py, and is
read by an external pager (sloppily) using the
profile.help() function.

Either the document should be updated and the help()
function should be more intelligent about the pager, or...
...the document and the help() function should be removed. 
This is a possibility since help() is not documented.

profile.doc should be updated for Python 2.2; other changes
will need to wait for Python 2.3.

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

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