Issue 489256: Lib/profile.doc should be updated (original) (raw)

This issue has been migrated to GitHub: https://github.com/python/cpython/issues/35667

classification

Title: Lib/profile.doc should be updated
Type: Stage:
Components: Documentation Versions:

process

Status: closed Resolution: fixed
Dependencies: Superseder:
Assigned To: jlgijsbers Nosy List: anthonybaxter, fdrake, georg.brandl, jlgijsbers
Priority: normal Keywords:

Created on 2001-12-05 05:51 by anthonybaxter, last changed 2022-04-10 16:04 by admin. This issue is now closed.

Messages (6)
msg7993 - (view) Author: Anthony Baxter (anthonybaxter) (Python triager) Date: 2001-12-05 05:51
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)
msg7994 - (view) Author: Fred Drake (fdrake) (Python committer) Date: 2001-12-05 06:08
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.
msg7995 - (view) Author: Johannes Gijsbers (jlgijsbers) * (Python triager) Date: 2005-01-09 01:27
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.
msg7996 - (view) Author: Fred Drake (fdrake) (Python committer) Date: 2005-01-10 03:07
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.
msg7997 - (view) Author: Johannes Gijsbers (jlgijsbers) * (Python triager) Date: 2005-01-10 09:07
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 (!).
msg7998 - (view) Author: Georg Brandl (georg.brandl) * (Python committer) Date: 2005-12-26 23:44
Logged In: YES user_id=1188172 Commented out the notes about the old profiler in rev. 41826. Closing this bug now.
History
Date User Action Args
2022-04-10 16:04:43 admin set github: 35667
2001-12-05 05:51:13 anthonybaxter create