From: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
Date: Thu, 27 Nov 2025 19:20:58 +0000 (+0000)
Subject: [3.13] gh-141004: Document `PyImport_Inittab` (GH-141844) (GH-142016)
X-Git-Tag: v3.13.10~27
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=3bbd669abbdfe16eb3c478138b4f83ca9f57e93f;p=thirdparty%2FPython%2Fcpython.git

[3.13] gh-141004: Document `PyImport_Inittab` (GH-141844) (GH-142016)

(cherry picked from commit 5f35702bb641230131c400500bb8bbacde7465b2)

Co-authored-by: Peter Bierma <zintensitydev@gmail.com>
Co-authored-by: Victor Stinner <vstinner@python.org>
---

diff --git a/Doc/c-api/import.rst b/Doc/c-api/import.rst
index 6e48644c8fef..56cf3ec3c129 100644
--- a/Doc/c-api/import.rst
+++ b/Doc/c-api/import.rst
@@ -325,3 +325,10 @@ Importing Modules
    If Python is initialized multiple times, :c:func:`PyImport_AppendInittab` or
    :c:func:`PyImport_ExtendInittab` must be called before each Python
    initialization.
+
+
+.. c:var:: struct _inittab *PyImport_Inittab
+
+   The table of built-in modules used by Python initialization. Do not use this directly;
+   use :c:func:`PyImport_AppendInittab` and :c:func:`PyImport_ExtendInittab`
+   instead.
diff --git a/Doc/extending/extending.rst b/Doc/extending/extending.rst
index dee92312169a..f9b65643dfe8 100644
--- a/Doc/extending/extending.rst
+++ b/Doc/extending/extending.rst
@@ -426,7 +426,7 @@ A pointer to the module definition must be returned via :c:func:`PyModuleDef_Ini
 so that the import machinery can create the module and store it in ``sys.modules``.
 
 When embedding Python, the :c:func:`!PyInit_spam` function is not called
-automatically unless there's an entry in the :c:data:`!PyImport_Inittab` table.
+automatically unless there's an entry in the :c:data:`PyImport_Inittab` table.
 To add the module to the initialization table, use :c:func:`PyImport_AppendInittab`,
 optionally followed by an import of the module::
 
diff --git a/Misc/NEWS.d/3.11.0a1.rst b/Misc/NEWS.d/3.11.0a1.rst
index f58d6b657e9b..ab998ca73abf 100644
--- a/Misc/NEWS.d/3.11.0a1.rst
+++ b/Misc/NEWS.d/3.11.0a1.rst
@@ -4931,7 +4931,7 @@ Patch by Gabriele N. Tornetta
 .. nonce: 3p14JB
 .. section: C API
 
-:c:func:`Py_RunMain` now resets :c:data:`!PyImport_Inittab` to its initial
+:c:func:`Py_RunMain` now resets :c:data:`PyImport_Inittab` to its initial
 value at exit. It must be possible to call :c:func:`PyImport_AppendInittab`
 or :c:func:`PyImport_ExtendInittab` at each Python initialization. Patch by
 Victor Stinner.
diff --git a/Misc/NEWS.d/3.12.0a2.rst b/Misc/NEWS.d/3.12.0a2.rst
index bc028f30636b..20e27c0d92f0 100644
--- a/Misc/NEWS.d/3.12.0a2.rst
+++ b/Misc/NEWS.d/3.12.0a2.rst
@@ -35,11 +35,11 @@ Update bundled libexpat to 2.5.0
 .. nonce: ik4iOv
 .. section: Core and Builtins
 
-The docs clearly say that ``PyImport_Inittab``,
+The docs clearly say that :c:data:`PyImport_Inittab`,
 :c:func:`PyImport_AppendInittab`, and :c:func:`PyImport_ExtendInittab`
 should not be used after :c:func:`Py_Initialize` has been called. We now
 enforce this for the two functions.  Additionally, the runtime now uses an
-internal copy of ``PyImport_Inittab``, to guard against modification.
+internal copy of :c:data:`PyImport_Inittab`, to guard against modification.
 
 ..