mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-10-03 13:45:29 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 8

[3.11] gh-93738: Documentation C syntax (:c:type:PyTupleObject* -> :c:expr:PyTupleObject*) (GH-97780) (#97863)

Browse source 
:c:type:`PyTupleObject*` -> :c:expr:`PyTupleObject*`
(cherry picked from commit 510baa429a)

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
This commit is contained in:
Miss Islington (bot) 2022-10-04 16:46:13 -07:00 • committed by GitHub
parent df133f54ef
commit a51124729a
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 1 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

2
Doc/c-api/typehints.rst
View file

@ -16,7 +16,7 @@ two types exist -- :ref:`GenericAlias <types-genericalias>` and
:class:`types.GenericAlias`. The *origin* and *args* arguments set the :class:`types.GenericAlias`. The *origin* and *args* arguments set the
``GenericAlias``\ 's ``__origin__`` and ``__args__`` attributes respectively. ``GenericAlias``\ 's ``__origin__`` and ``__args__`` attributes respectively.
*origin* should be a :c:type:`PyTypeObject*`, and *args* can be a *origin* should be a :c:type:`PyTypeObject*`, and *args* can be a
:c:type:`PyTupleObject*` or any ``PyObject*``. If *args* passed is :c:expr:`PyTupleObject*` or any ``PyObject*``. If *args* passed is
not a tuple, a 1-tuple is automatically constructed and ``__args__`` is set not a tuple, a 1-tuple is automatically constructed and ``__args__`` is set
to ``(args,)``. to ``(args,)``.
Minimal checking is done for the arguments, so the function will succeed even Minimal checking is done for the arguments, so the function will succeed even