python / cpython

The Python programming language
https://www.python.org
Other
63.16k stars 30.24k forks source link

site.py documentation does not mention special objects help, quit etc added to builtins #103066

Open stevendaprano opened 1 year ago

stevendaprano commented 1 year ago

The site.py documentation does not mention the special objects that it adds to builtins:

(Have I missed any?) The second paragraph hints at them, saying "Importing this module will append site-specific paths to the module search path and add a few builtins" but fails to mention what those builtins are. We should add a brief section listing those added objects, and in the case of help linking to pydoc.

Linked PRs

terryjreedy commented 1 year ago

The exact additions are potentially site-specific, but we could add the current default additions as long as they are labelled as such and not as guarantees.

stevendaprano commented 1 year ago

How are they more site specific than everything else in the site module?