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: Stop documenting functions added by site as builtins
Type: Stage: resolved
Components: Documentation Versions: Python 3.2, Python 3.3, Python 2.7
process
Status: closed Resolution: works for me
Dependencies: Superseder:
Assigned To: eric.araujo Nosy List: eric.araujo, terry.reedy
Priority: normal Keywords:

Created on 2011-06-09 16:17 by eric.araujo, last changed 2022-04-11 14:57 by admin. This issue is now closed.

Messages (4)
msg138001 - (view) Author: Éric Araujo (eric.araujo) * (Python committer) Date: 2011-06-09 16:17
I find it harmful that exit, quit and help are documented in library/functions instead of library/constants (under the section “constants added by the site module”).  It leads people to use unqualified help or exit instead of pydoc.help or sys.exit, and that would break under -S.  I’d like to move the doc for these functions (and add a link from l/functions to l/constants).
msg138148 - (view) Author: Terry J. Reedy (terry.reedy) * (Python committer) Date: 2011-06-11 02:37
In the 3.2.0 doc, quit and exit (which are unnecessary and nearly useless) are already in the site-variables section (where I think they should be), not in builtin funcs. Did someone move them since? If so, you should discuss rather than just revert. 

The extremely useful help() is documented with builtin funcs, where beginners can it easily. It is used (frequently) in interactive mode. It is documented as being added by site. It could *also* be listed with quit and exit in the site additions section. Anyone sophisticated (foolish) enough to start interactive mode with -S (a bit hard on Windows) should know the consequences. I am opposed to removing the current entry.
msg143792 - (view) Author: Terry J. Reedy (terry.reedy) * (Python committer) Date: 2011-09-09 19:28
Can we close this as out-of-date, since 2/3rds of what you asked seems to be done already, and the last 1/3 should (in my opinion) absolutely not be?
msg143912 - (view) Author: Éric Araujo (eric.araujo) * (Python committer) Date: 2011-09-12 15:54
Agreed.
History
Date User Action Args
2022-04-11 14:57:18adminsetgithub: 56508
2011-09-12 15:54:05eric.araujosetstatus: open -> closed
resolution: works for me
messages: + msg143912

stage: resolved
2011-09-09 19:28:51terry.reedysetmessages: + msg143792
2011-06-11 02:37:32terry.reedysetnosy: + terry.reedy
messages: + msg138148
2011-06-09 16:17:49eric.araujocreate