diff options
author | Miss Islington (bot) <31488909+miss-islington@users.noreply.github.com> | 2023-07-28 06:17:49 (GMT) |
---|---|---|
committer | GitHub <noreply@github.com> | 2023-07-28 06:17:49 (GMT) |
commit | 17ce87ba7f8e4f8c9a5620ebf24a968f742b6e28 (patch) | |
tree | 73fc0f1b03f91c9ccff65d38049a96fd7f05b91f /Doc/c-api | |
parent | 2827ad2f317fceaa618bbdb5900b76613af3aa69 (diff) | |
download | cpython-17ce87ba7f8e4f8c9a5620ebf24a968f742b6e28.zip cpython-17ce87ba7f8e4f8c9a5620ebf24a968f742b6e28.tar.gz cpython-17ce87ba7f8e4f8c9a5620ebf24a968f742b6e28.tar.bz2 |
[3.12] gh-107298: Fix doc references to undocumented modules (GH-107300) (GH-107370)
Update also Doc/tools/.nitignore.
(cherry picked from commit 87b39028e5f453a949a1675526c439f6479a04a8)
Co-authored-by: Victor Stinner <vstinner@python.org>
Diffstat (limited to 'Doc/c-api')
-rw-r--r-- | Doc/c-api/arg.rst | 2 | ||||
-rw-r--r-- | Doc/c-api/codec.rst | 2 | ||||
-rw-r--r-- | Doc/c-api/typeobj.rst | 2 | ||||
-rw-r--r-- | Doc/c-api/unicode.rst | 2 |
4 files changed, 4 insertions, 4 deletions
diff --git a/Doc/c-api/arg.rst b/Doc/c-api/arg.rst index ea176bd..c09c2d5 100644 --- a/Doc/c-api/arg.rst +++ b/Doc/c-api/arg.rst @@ -469,7 +469,7 @@ API Functions will be set if there was a failure. This is an example of the use of this function, taken from the sources for the - :mod:`_weakref` helper module for weak references:: + :mod:`!_weakref` helper module for weak references:: static PyObject * weakref_ref(PyObject *self, PyObject *args) diff --git a/Doc/c-api/codec.rst b/Doc/c-api/codec.rst index 235c77c..8ae5c4f 100644 --- a/Doc/c-api/codec.rst +++ b/Doc/c-api/codec.rst @@ -7,7 +7,7 @@ Codec registry and support functions Register a new codec search function. - As side effect, this tries to load the :mod:`encodings` package, if not yet + As side effect, this tries to load the :mod:`!encodings` package, if not yet done, to make sure that it is always first in the list of search functions. .. c:function:: int PyCodec_Unregister(PyObject *search_function) diff --git a/Doc/c-api/typeobj.rst b/Doc/c-api/typeobj.rst index e70b824..40d2105 100644 --- a/Doc/c-api/typeobj.rst +++ b/Doc/c-api/typeobj.rst @@ -579,7 +579,7 @@ and :c:data:`PyType_Type` effectively act as defaults.) name, followed by a dot, followed by the type name; for built-in types, it should be just the type name. If the module is a submodule of a package, the full package name is part of the full module name. For example, a type named - :class:`T` defined in module :mod:`M` in subpackage :mod:`Q` in package :mod:`P` + :class:`T` defined in module :mod:`!M` in subpackage :mod:`!Q` in package :mod:`!P` should have the :c:member:`~PyTypeObject.tp_name` initializer ``"P.Q.M.T"``. For :ref:`dynamically allocated type objects <heap-types>`, diff --git a/Doc/c-api/unicode.rst b/Doc/c-api/unicode.rst index 957934c..6ae652e 100644 --- a/Doc/c-api/unicode.rst +++ b/Doc/c-api/unicode.rst @@ -1212,7 +1212,7 @@ Character Map Codecs This codec is special in that it can be used to implement many different codecs (and this is in fact what was done to obtain most of the standard codecs -included in the :mod:`encodings` package). The codec uses mappings to encode and +included in the :mod:`!encodings` package). The codec uses mappings to encode and decode characters. The mapping objects provided must support the :meth:`__getitem__` mapping interface; dictionaries and sequences work well. |