summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMiss Islington (bot) <31488909+miss-islington@users.noreply.github.com>2022-10-05 15:21:32 (GMT)
committerGitHub <noreply@github.com>2022-10-05 15:21:32 (GMT)
commit5c8aa2e0f224179e5ee3086b295a735610e9e5c7 (patch)
tree704285458b077ccfffbb888cbbeb8a19407794a9
parentd5852a090fc5bfdc99e8d8f5e1e890cac8102d4e (diff)
downloadcpython-5c8aa2e0f224179e5ee3086b295a735610e9e5c7.zip
cpython-5c8aa2e0f224179e5ee3086b295a735610e9e5c7.tar.gz
cpython-5c8aa2e0f224179e5ee3086b295a735610e9e5c7.tar.bz2
[3.11] gh-93738: Documentation C syntax (:c:type:`PyTypeObject*` -> :c:expr:`PyTypeObject*`) (GH-97778) (#97892)
Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com> (cherry picked from commit c70c8b69762f720377adaf22f2e5ec6496a7be53) Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
-rw-r--r--Doc/c-api/object.rst2
-rw-r--r--Doc/c-api/typehints.rst2
2 files changed, 2 insertions, 2 deletions
diff --git a/Doc/c-api/object.rst b/Doc/c-api/object.rst
index fb03366..5a25a2b 100644
--- a/Doc/c-api/object.rst
+++ b/Doc/c-api/object.rst
@@ -310,7 +310,7 @@ Object Protocol
is equivalent to the Python expression ``type(o)``. This function increments the
reference count of the return value. There's really no reason to use this
function instead of the :c:func:`Py_TYPE()` function, which returns a
- pointer of type :c:type:`PyTypeObject*`, except when the incremented reference
+ pointer of type :c:expr:`PyTypeObject*`, except when the incremented reference
count is needed.
diff --git a/Doc/c-api/typehints.rst b/Doc/c-api/typehints.rst
index 88554a3..4c1957a 100644
--- a/Doc/c-api/typehints.rst
+++ b/Doc/c-api/typehints.rst
@@ -15,7 +15,7 @@ two types exist -- :ref:`GenericAlias <types-genericalias>` and
Equivalent to calling the Python class
:class:`types.GenericAlias`. The *origin* and *args* arguments set the
``GenericAlias``\ 's ``__origin__`` and ``__args__`` attributes respectively.
- *origin* should be a :c:type:`PyTypeObject*`, and *args* can be a
+ *origin* should be a :c:expr:`PyTypeObject*`, and *args* can be a
:c:expr:`PyTupleObject*` or any ``PyObject*``. If *args* passed is
not a tuple, a 1-tuple is automatically constructed and ``__args__`` is set
to ``(args,)``.