Skip to content

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

@stevendaprano

Description

@stevendaprano

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

  • help
  • quit and exit
  • license viewer
  • copyright and credit strings.

(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

Metadata

Metadata

Assignees

No one assigned

    Labels

    docsDocumentation in the Doc direasy

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions