]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
[3.11] gh-107091: Fix some uses of :c:member: role (GH-107129) (GH-107311)
authorSerhiy Storchaka <storchaka@gmail.com>
Wed, 26 Jul 2023 19:35:16 +0000 (22:35 +0300)
committerGitHub <noreply@github.com>
Wed, 26 Jul 2023 19:35:16 +0000 (19:35 +0000)
(cherry picked from commit af61cb9c7837ff3c11da79e3ee1cab3fdd0ba4da)

Doc/c-api/import.rst
Doc/c-api/init_config.rst
Doc/c-api/module.rst
Doc/c-api/structures.rst
Doc/howto/isolating-extensions.rst
Doc/whatsnew/3.5.rst
Doc/whatsnew/3.7.rst

index 4ca1517efcb38d9a15758f66fd456c3f24b0759f..8b2d38582343b70ef9a7450a38f0833f11037bb8 100644 (file)
@@ -138,7 +138,7 @@ Importing Modules
    :class:`SourceFileLoader` otherwise.
 
    The module's :attr:`__file__` attribute will be set to the code object's
-   :c:member:`co_filename`.  If applicable, :attr:`__cached__` will also
+   :attr:`co_filename`.  If applicable, :attr:`__cached__` will also
    be set.
 
    This function will reload the module if it was already imported.  See
index 24d66201f68dbbc4c51d8d0f92b300585fcc0eb8..715ad47f13eb4568588f0ef95946d653b42ad77e 100644 (file)
@@ -522,7 +522,7 @@ PyConfig
    Moreover, if :c:func:`PyConfig_SetArgv` or :c:func:`PyConfig_SetBytesArgv`
    is used, this method must be called before other methods, since the
    preinitialization configuration depends on command line arguments (if
-   :c:member:`parse_argv` is non-zero).
+   :c:member:`~PyConfig.parse_argv` is non-zero).
 
    The caller of these methods is responsible to handle exceptions (error or
    exit) using ``PyStatus_Exception()`` and ``Py_ExitStatusException()``.
index e358c5da14a69f4ea84b62e3603e7d5b2e71a39f..6abd550ab80b216e10bbc3911c1ecdf04e6ee062 100644 (file)
@@ -164,7 +164,7 @@ or request "multi-phase initialization" by returning the definition struct itsel
 
       This memory area is allocated based on *m_size* on module creation,
       and freed when the module object is deallocated, after the
-      :c:member:`m_free` function has been called, if present.
+      :c:member:`~PyModuleDef.m_free` function has been called, if present.
 
       Setting ``m_size`` to ``-1`` means that the module does not support
       sub-interpreters, because it has global state.
@@ -202,7 +202,7 @@ or request "multi-phase initialization" by returning the definition struct itsel
       This function is not called if the module state was requested but is not
       allocated yet. This is the case immediately after the module is created
       and before the module is executed (:c:data:`Py_mod_exec` function). More
-      precisely, this function is not called if :c:member:`m_size` is greater
+      precisely, this function is not called if :c:member:`~PyModuleDef.m_size` is greater
       than 0 and the module state (as returned by :c:func:`PyModule_GetState`)
       is ``NULL``.
 
@@ -217,7 +217,7 @@ or request "multi-phase initialization" by returning the definition struct itsel
       This function is not called if the module state was requested but is not
       allocated yet. This is the case immediately after the module is created
       and before the module is executed (:c:data:`Py_mod_exec` function). More
-      precisely, this function is not called if :c:member:`m_size` is greater
+      precisely, this function is not called if :c:member:`~PyModuleDef.m_size` is greater
       than 0 and the module state (as returned by :c:func:`PyModule_GetState`)
       is ``NULL``.
 
@@ -238,7 +238,7 @@ or request "multi-phase initialization" by returning the definition struct itsel
       This function is not called if the module state was requested but is not
       allocated yet. This is the case immediately after the module is created
       and before the module is executed (:c:data:`Py_mod_exec` function). More
-      precisely, this function is not called if :c:member:`m_size` is greater
+      precisely, this function is not called if :c:member:`~PyModuleDef.m_size` is greater
       than 0 and the module state (as returned by :c:func:`PyModule_GetState`)
       is ``NULL``.
 
index e9f158c176924e5da6a11eeb487e3c3121ffb4d9..5c85838d2dbfa0617c480658751cf37060eb8ed8 100644 (file)
@@ -263,14 +263,16 @@ Implementing functions and methods
 
       points to the contents of the docstring
 
-The :c:member:`ml_meth` is a C function pointer.  The functions may be of different
+The :c:member:`~PyMethodDef.ml_meth` is a C function pointer.
+The functions may be of different
 types, but they always return :c:expr:`PyObject*`.  If the function is not of
 the :c:type:`PyCFunction`, the compiler will require a cast in the method table.
 Even though :c:type:`PyCFunction` defines the first parameter as
 :c:expr:`PyObject*`, it is common that the method implementation uses the
 specific C type of the *self* object.
 
-The :c:member:`ml_flags` field is a bitfield which can include the following flags.
+The :c:member:`~PyMethodDef.ml_flags` field is a bitfield which can include
+the following flags.
 The individual flags indicate either a calling convention or a binding
 convention.
 
index c88c9edc0ccad2c95194d1e6e54ca0e8978745d9..0362fa6c68544358ee4aa6874b967816da11582a 100644 (file)
@@ -467,7 +467,7 @@ Module State Access from Slot Methods, Getters and Setters
 
 Slot methods—the fast C equivalents for special methods, such as
 :c:member:`~PyNumberMethods.nb_add` for :py:attr:`~object.__add__` or
-:c:member:`~PyType.tp_new` for initialization—have a very simple API that
+:c:member:`~PyTypeObject.tp_new` for initialization—have a very simple API that
 doesn't allow passing in the defining class, unlike with :c:type:`PyCMethod`.
 The same goes for getters and setters defined with
 :c:type:`PyGetSetDef`.
index 315de6b59fe5f01b6b531c6fb51a8fd8654a332f..9bd97e4726ca24b82388d81f53718d14299f5120 100644 (file)
@@ -2533,7 +2533,7 @@ Changes in the C API
 
 * As part of the :pep:`492` implementation, the ``tp_reserved`` slot of
   :c:type:`PyTypeObject` was replaced with a
-  :c:member:`tp_as_async` slot.  Refer to :ref:`coro-objects` for
+  :c:member:`~PyTypeObject.tp_as_async` slot.  Refer to :ref:`coro-objects` for
   new types, structures and functions.
 
 
index d00c55a77661364073757864374a827fdee6bc19..02406691d4ac7d49f7122993af2ab0496c48cd68 100644 (file)
@@ -1674,7 +1674,7 @@ The new :c:func:`import__find__load__start` and
 module imports.
 (Contributed by Christian Heimes in :issue:`31574`.)
 
-The fields :c:member:`name` and :c:member:`doc` of structures
+The fields :c:member:`!name` and :c:member:`!doc` of structures
 :c:type:`PyMemberDef`, :c:type:`PyGetSetDef`,
 :c:type:`PyStructSequence_Field`, :c:type:`PyStructSequence_Desc`,
 and :c:type:`wrapperbase` are now of type ``const char *`` rather of