diff options
author | Adam Turner <9087854+AA-Turner@users.noreply.github.com> | 2022-10-05 00:56:20 (GMT) |
---|---|---|
committer | GitHub <noreply@github.com> | 2022-10-05 00:56:20 (GMT) |
commit | c70c8b69762f720377adaf22f2e5ec6496a7be53 (patch) | |
tree | edc5ba6d7572b81c2898654d100de5db3bf335f3 /Doc/c-api | |
parent | db64fb9bbe92b212db7dd173f787ea3607ae971a (diff) | |
download | cpython-c70c8b69762f720377adaf22f2e5ec6496a7be53.zip cpython-c70c8b69762f720377adaf22f2e5ec6496a7be53.tar.gz cpython-c70c8b69762f720377adaf22f2e5ec6496a7be53.tar.bz2 |
gh-93738: Documentation C syntax (:c:type:`PyTypeObject*` -> :c:expr:`PyTypeObject*`) (#97778)
Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
Diffstat (limited to 'Doc/c-api')
-rw-r--r-- | Doc/c-api/object.rst | 2 | ||||
-rw-r--r-- | Doc/c-api/typehints.rst | 2 |
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,)``. |