Skip to content

bpo-47097: Add documentation for TypeVarTuple #32103

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
JelleZijlstra merged 14 commits into from
Apr 4, 2022
Merged

bpo-47097: Add documentation for TypeVarTuple #32103

Changes from 1 commit
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
f5d5c14
Add documentation for TypeVarTuple
mrahtz Mar 24, 2022
34111b6
Address Jelle and Guido's feedback on TypeVarTuple
mrahtz Mar 26, 2022
3802fe2
Add short section on Unpack
mrahtz Mar 26, 2022
c755600
Explicit mention Generic[*Shape, DType] as fine
mrahtz Mar 30, 2022
b97827c
Incorporate Alex's feedback
mrahtz Mar 30, 2022
5362e03
Switch initial example to remove_first_element
mrahtz Apr 2, 2022
c0eb4ce
Switch to call_soon for *args: *Ts example
mrahtz Apr 2, 2022
3bc701e
Explicitly state the tuple[*Ts, *Ts] is invalid too
mrahtz Apr 2, 2022
896f4f4
Expand remove_first_element example
mrahtz Apr 2, 2022
5d67004
Add note about why typing_extensions
mrahtz Apr 2, 2022
29e7a26
Make explanation comment consistent
mrahtz Apr 2, 2022
3e0fcb7
Fix typo
mrahtz Apr 2, 2022
c346065
Replace arg name 'xs' with 'tup'
mrahtz Apr 2, 2022
6680177
Fix final nits
mrahtz Apr 4, 2022
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
Prev Previous commit
Fix final nits 
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
  • Loading branch information
@mrahtz @JelleZijlstra
mrahtz and JelleZijlstra authored Apr 4, 2022
commit 668017764ab217bd1b82a22517854a44609c762b
4 changes: 2 additions & 2 deletions Doc/library/typing.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1234,7 +1234,7 @@ These are not used in annotations. They are building blocks for creating generic

.. class:: TypeVarTuple

Type variable tuple. A specialised form of :class:`Type variable <TypeVar>`
Type variable tuple. A specialized form of :class:`Type variable <TypeVar>`
that enables *variadic* generics.

A normal type variable enables parameterization with a single type. A type
Expand Down Expand Up @@ -1329,7 +1329,7 @@ These are not used in annotations. They are building blocks for creating generic

A typing operator that conceptually marks an object as having been
unpacked. For example, using the unpack operator ``*`` on a
:class:`type variable tuple <TypeVarTuple>` internally uses ``Unpack``
:class:`type variable tuple <TypeVarTuple>` is equivalent to using ``Unpack``
to mark the type variable tuple as having been unpacked::

Ts = TypeVarTuple('Ts')
Expand Down