From: Miss Islington (bot) <31488909+miss-islington@users.noreply.github.com>
Date: Fri, 6 Sep 2024 08:08:32 +0000 (+0200)
Subject: [3.12] gh-103066: Add links and `help` in site.py constants (GH-103777) (#123763)
X-Git-Tag: v3.12.6~15
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=17249f3a8fce233d4cb0f371d9978e281315bc46;p=thirdparty%2FPython%2Fcpython.git

[3.12] gh-103066: Add links and `help` in site.py constants (GH-103777) (#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>
---

diff --git a/Doc/library/constants.rst b/Doc/library/constants.rst
index 93a7244f87de..3eceecc4e0a7 100644
--- a/Doc/library/constants.rst
+++ b/Doc/library/constants.rst
@@ -79,6 +79,8 @@ A small number of constants live in the built-in namespace.  They are:
    :exc:`SyntaxError`), so they can be considered "true" constants.
 
 
+.. _site-consts:
+
 Constants added by the :mod:`site` module
 -----------------------------------------
 
@@ -94,6 +96,13 @@ should not be used in programs.
    (i.e. EOF) to exit", and when called, raise :exc:`SystemExit` with the
    specified exit code.
 
+.. data:: help
+   :noindex:
+
+   Object that when printed, prints the message "Type help() for interactive
+   help, or help(object) for help about object.", and when called,
+   acts as described :func:`elsewhere <help>`.
+
 .. data:: copyright
           credits
 
diff --git a/Doc/library/site.rst b/Doc/library/site.rst
index f5cf81fb1c9a..514eed314ea6 100644
--- a/Doc/library/site.rst
+++ b/Doc/library/site.rst
@@ -15,8 +15,9 @@ import can be suppressed using the interpreter's :option:`-S` option.
 
 .. index:: triple: module; search; path
 
-Importing this module will append site-specific paths to the module search path
-and add a few builtins, unless :option:`-S` was used.  In that case, this module
+Importing this module normally appends site-specific paths to the module search path
+and adds :ref:`callables <site-consts>`, including :func:`help` to the built-in
+namespace. However, Python startup option :option:`-S` blocks this and this module
 can be safely imported with no automatic modifications to the module search path
 or additions to the builtins.  To explicitly trigger the usual site-specific
 additions, call the :func:`main` function.