Skip to content

Commit 2af31cf

Browse files
miss-islingtonAA-Turner
authored andcommitted
[3.11] gh-93738: Documentation C syntax (:c:type:PyTypeObject* -> :c:expr:PyTypeObject*) (GH-97778) (#97892)
Co-authored-by: Ezio Melotti <[email protected]> (cherry picked from commit c70c8b6) Co-authored-by: Adam Turner <[email protected]>
1 parent 6ff98f7 commit 2af31cf

File tree

2 files changed

+3
-3
lines changed

2 files changed

+3
-3
lines changed

Doc/c-api/object.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -310,7 +310,7 @@ Object Protocol
310310
is equivalent to the Python expression ``type(o)``. This function increments the
311311
reference count of the return value. There's really no reason to use this
312312
function instead of the :c:func:`Py_TYPE()` function, which returns a
313-
pointer of type :c:type:`PyTypeObject*`, except when the incremented reference
313+
pointer of type :c:expr:`PyTypeObject*`, except when the incremented reference
314314
count is needed.
315315
316316

Doc/c-api/typehints.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,8 @@ two types exist -- :ref:`GenericAlias <types-genericalias>` and
1515
Equivalent to calling the Python class
1616
:class:`types.GenericAlias`. The *origin* and *args* arguments set the
1717
``GenericAlias``\ 's ``__origin__`` and ``__args__`` attributes respectively.
18-
*origin* should be a :c:type:`PyTypeObject*`, and *args* can be a
19-
:c:type:`PyTupleObject*` or any ``PyObject*``. If *args* passed is
18+
*origin* should be a :c:expr:`PyTypeObject*`, and *args* can be a
19+
:c:expr:`PyTupleObject*` or any ``PyObject*``. If *args* passed is
2020
not a tuple, a 1-tuple is automatically constructed and ``__args__`` is set
2121
to ``(args,)``.
2222
Minimal checking is done for the arguments, so the function will succeed even

0 commit comments

Comments
 (0)