[issue12299] Stop documenting functions added by site as builtins
Éric Araujo mer...@netwok.org added the comment: Agreed. -- resolution: - works for me stage: - committed/rejected status: open - closed ___ Python tracker rep...@bugs.python.org http://bugs.python.org/issue12299 ___ ___ Python-bugs-list mailing list Unsubscribe: http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com
[issue12299] Stop documenting functions added by site as builtins
Terry J. Reedy tjre...@udel.edu added the comment: 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? -- ___ Python tracker rep...@bugs.python.org http://bugs.python.org/issue12299 ___ ___ Python-bugs-list mailing list Unsubscribe: http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com
[issue12299] Stop documenting functions added by site as builtins
Terry J. Reedy tjre...@udel.edu added the comment: 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. -- nosy: +terry.reedy ___ Python tracker rep...@bugs.python.org http://bugs.python.org/issue12299 ___ ___ Python-bugs-list mailing list Unsubscribe: http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com
[issue12299] Stop documenting functions added by site as builtins
New submission from Éric Araujo mer...@netwok.org: 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). -- assignee: eric.araujo components: Documentation messages: 138001 nosy: eric.araujo priority: normal severity: normal status: open title: Stop documenting functions added by site as builtins versions: Python 2.7, Python 3.2, Python 3.3 ___ Python tracker rep...@bugs.python.org http://bugs.python.org/issue12299 ___ ___ Python-bugs-list mailing list Unsubscribe: http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com
