Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 4, 2022
Merged

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

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
gh-93738: Documentation C syntax (:c:type:PyTupleObject* -> :c:expr… 
…:`PyTupleObject*`) (GH-97780)

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

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
  • Loading branch information
@AA-Turner @miss-islington
AA-Turner authored and miss-islington committed Oct 4, 2022
commit 98f94fc19e29dfd0ee02c38c3ac4a0d81f4f419b
2 changes: 1 addition & 1 deletion Doc/c-api/typehints.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ two types exist -- :ref:`GenericAlias <types-genericalias>` and
: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
: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
to ``(args,)``.
Minimal checking is done for the arguments, so the function will succeed even
Expand Down