Typing docs: improve the guidance on annotating tuples #106021
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
AlexWaygood
requested review from
gvanrossum,
Fidget-Spinner and
JelleZijlstra
as code owners
bedevere-bot
added
awaiting core review
docs
AlexWaygood
added
needs backport to 3.11
AlexWaygood
commented
Jun 23, 2023
AlexWaygood
commented
Jun 23, 2023
JelleZijlstra
approved these changes
Jun 23, 2023
|
Thanks @AlexWaygood for the PR 🌮🎉.. I'm working now to backport this PR to: 3.11, 3.12. |
miss-islington
pushed a commit
to miss-islington/cpython
that referenced
this pull request
Jun 23, 2023
(cherry picked from commit 968435d) Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
|
GH-106027 is a backport of this pull request to the 3.12 branch. |
|
GH-106029 is a backport of this pull request to the 3.11 branch. |
miss-islington
pushed a commit
to miss-islington/cpython
that referenced
this pull request
Jun 23, 2023
(cherry picked from commit 968435d) Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
AlexWaygood
added a commit
that referenced
this pull request
Jun 23, 2023
AlexWaygood
added a commit
that referenced
this pull request
Jun 23, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
typing.Tupleout of the section for special forms, and into the section for deprecated aliases.typing.Tupleis general guidance on how to annotate tuples in Python. Remove it from the entry fortyping.Tuple, and add a section at the top on annotating tuples, similar to the existing section we already have on annotating callables.Maybe this new section would be better suited to typing.readthedocs.io? Not sure -- I feel like
Tuplebelongs in the deprecated aliases section; I feel like the information on annotating tuples in general does not belong in the entry forTuple; and it would feel strange to me to not mention anywhere intyping.rstthe way in whichtupleis special-cased in the type system.