8000 site.py documentation does not mention special objects help, quit etc added to builtins · Issue #103066 · python/cpython · GitHub
[go: up one dir, main page]
Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Closed
stevendaprano opened this issue Mar 28, 2023 · 3 comments
Closed

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

stevendaprano opened this issue Mar 28, 2023 · 3 comments
Labels
docs Documentation in the Doc dir easy

Comments

@stevendaprano
Copy link
Member
stevendaprano commented Mar 28, 2023 •
edited by bedevere-app bot
Loading

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
@stevendaprano stevendaprano added docs Documentation in the Doc dir easy labels Mar 28, 2023
@terryjreedy
Copy link
Member

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
Copy link
Member Author

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

@davidcaron davidcaron mentioned this issue Apr 24, 2023
Merged
hugovk pushed a commit that referenced this issue Sep 6, 2024
@davidcaron @terryjreedy
@ambv @serhiy-storchaka @AlexWaygood
gh-103066: Add links and help in site.py constants (#103777)
67957ea 
Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
Co-authored-by: Łukasz Langa <lukasz@langa.pl>
Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
miss-islington pushed a commit to miss-islington/cpython that referenced this issue Sep 6, 2024
@davidcaron @terryjreedy
@ambv @serhiy-storchaka @AlexWaygood @miss-islington
pythongh-103066: Add links and help in site.py constants (pythonGH-…
1f49c16 
…103777)

(cherry picked from commit 67957ea)

Co-authored-by: David Caron <dcaron05@gmail.com>
Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
Co-authored-by: Łukasz Langa <lukasz@langa.pl>
Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
miss-islington pushed a commit to miss-islington/cpython that referenced this issue Sep 6, 2024
@davidcaron @terryjreedy
@ambv @serhiy-storchaka @AlexWaygood @miss-islington
pythongh-103066: Add links and help in site.py constants (pythonGH-…
e8a28a2 
…103777)

(cherry picked from commit 67957ea)

Co-authored-by: David Caron <dcaron05@gmail.com>
Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
Co-authored-by: Łukasz Langa <lukasz@langa.pl>
Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
This was referenced Sep 6, 2024
Merged
Merged
hugovk pushed a commit that referenced this issue Sep 6, 2024
@miss-islington @davidcaron
@terryjreedy @ambv @serhiy-storchaka @AlexWaygood
[3.13] gh-103066: Add links and help in site.py constants (GH-103777)…
37e1f8d 
… (#123762)

Co-authored-by: David Caron <dcaron05@gmail.com>
Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
Co-authored-by: Łukasz Langa <lukasz@langa.pl>
Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
hugovk pushed a commit that referenced this issue Sep 6, 2024
@miss-islington @davidcaron
@terryjreedy @ambv @serhiy-storchaka @AlexWaygood
[3.12] gh-103066: Add links and help in site.py constants (GH-103777)…
17249f3 
… (#123763)

Co-authored-by: David Caron <dcaron05@gmail.com>
Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
Co-authored-by: Łukasz Langa <lukasz@langa.pl>
Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
@hugovk
Copy link
Member
hugovk commented Jan 8, 2025

I think we can close this now the PR has been merged and backported. Please re-open if still needed. Thanks!

@hugovk hugovk closed this as completed Jan 8, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
docs Documentation in the Doc dir easy
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@hugovk @terryjreedy @stevendaprano
0