summaryrefslogtreecommitdiffstats
path: root/Doc/extending
diff options
context:
space:
mode:
authorVictor Stinner <vstinner@python.org>2023-07-26 16:59:06 (GMT)
committerGitHub <noreply@github.com>2023-07-26 16:59:06 (GMT)
commit87b39028e5f453a949a1675526c439f6479a04a8 (patch)
tree9fffc46d231914c9f3fe91678f25032e7337e735 /Doc/extending
parentb1de3807b832b72dfeb66dd5646159d08d2cc74a (diff)
downloadcpython-87b39028e5f453a949a1675526c439f6479a04a8.zip
cpython-87b39028e5f453a949a1675526c439f6479a04a8.tar.gz
cpython-87b39028e5f453a949a1675526c439f6479a04a8.tar.bz2
gh-107298: Fix doc references to undocumented modules (#107300)
Update also Doc/tools/.nitignore.
Diffstat (limited to 'Doc/extending')
-rw-r--r--Doc/extending/extending.rst4
-rw-r--r--Doc/extending/newtypes_tutorial.rst8
2 files changed, 6 insertions, 6 deletions
diff --git a/Doc/extending/extending.rst b/Doc/extending/extending.rst
index 00a9edc..94ead2b 100644
--- a/Doc/extending/extending.rst
+++ b/Doc/extending/extending.rst
@@ -367,7 +367,7 @@ Note that PyMODINIT_FUNC declares the function as ``PyObject *`` return type,
declares any special linkage declarations required by the platform, and for C++
declares the function as ``extern "C"``.
-When the Python program imports module :mod:`spam` for the first time,
+When the Python program imports module :mod:`!spam` for the first time,
:c:func:`PyInit_spam` is called. (See below for comments about embedding Python.)
It calls :c:func:`PyModule_Create`, which returns a module object, and
inserts built-in function objects into the newly created module based upon the
@@ -1219,7 +1219,7 @@ file corresponding to the module provides a macro that takes care of importing
the module and retrieving its C API pointers; client modules only have to call
this macro before accessing the C API.
-The exporting module is a modification of the :mod:`spam` module from section
+The exporting module is a modification of the :mod:`!spam` module from section
:ref:`extending-simpleexample`. The function :func:`spam.system` does not call
the C library function :c:func:`system` directly, but a function
:c:func:`PySpam_System`, which would of course do something more complicated in
diff --git a/Doc/extending/newtypes_tutorial.rst b/Doc/extending/newtypes_tutorial.rst
index 4f9c889..a05bae8 100644
--- a/Doc/extending/newtypes_tutorial.rst
+++ b/Doc/extending/newtypes_tutorial.rst
@@ -37,7 +37,7 @@ object.
This sort of thing can only be explained by example, so here's a minimal, but
complete, module that defines a new type named :class:`Custom` inside a C
-extension module :mod:`custom`:
+extension module :mod:`!custom`:
.. note::
What we're showing here is the traditional way of defining *static*
@@ -55,7 +55,7 @@ from the previous chapter. This file defines three things:
#. How the :class:`Custom` **type** behaves: this is the ``CustomType`` struct,
which defines a set of flags and function pointers that the interpreter
inspects when specific operations are requested.
-#. How to initialize the :mod:`custom` module: this is the ``PyInit_custom``
+#. How to initialize the :mod:`!custom` module: this is the ``PyInit_custom``
function and the associated ``custommodule`` struct.
The first bit is::
@@ -127,7 +127,7 @@ our objects and in some error messages, for example:
TypeError: can only concatenate str (not "custom.Custom") to str
Note that the name is a dotted name that includes both the module name and the
-name of the type within the module. The module in this case is :mod:`custom` and
+name of the type within the module. The module in this case is :mod:`!custom` and
the type is :class:`Custom`, so we set the type name to :class:`custom.Custom`.
Using the real dotted import path is important to make your type compatible
with the :mod:`pydoc` and :mod:`pickle` modules. ::
@@ -229,7 +229,7 @@ Adding data and methods to the Basic example
============================================
Let's extend the basic example to add some data and methods. Let's also make
-the type usable as a base class. We'll create a new module, :mod:`custom2` that
+the type usable as a base class. We'll create a new module, :mod:`!custom2` that
adds these capabilities:
.. literalinclude:: ../includes/custom2.c