typing: Improve documentation of generic classes and aliases #105369
Merged
Conversation
This file contains hidden or 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
added
topic-typing
needs backport to 3.11
AlexWaygood
requested review from
gvanrossum,
Fidget-Spinner and
JelleZijlstra
as code owners
bedevere-bot
added
awaiting core review
docs
AlexWaygood
commented
Jun 6, 2023
Doc/library/typing.rst
Outdated
Comment on lines
322
to
323
| def second(l: Sequence[U]) -> U: # Function is generic around the TypeVar "U" | ||
| return l[1] |
There was a problem hiding this comment.
I figured it was slightly confusing to have two functions named first in two adjacent code examples
AlexWaygood
changed the title
JelleZijlstra
approved these changes
Jun 7, 2023
|
Thanks @AlexWaygood for the PR 🌮🎉.. I'm working now to backport this PR to: 3.11, 3.12. |
|
Sorry, @AlexWaygood, I could not cleanly backport this to |
miss-islington
pushed a commit
to miss-islington/cpython
that referenced
this pull request
Jun 7, 2023
…H-105369) (cherry picked from commit d63a7c3) Co-authored-by: Alex Waygood <[email protected]>
|
GH-105453 is a backport of this pull request to the 3.12 branch. |
|
GH-105454 is a backport of this pull request to the 3.11 branch. |
AlexWaygood
added a commit
that referenced
this pull request
Jun 7, 2023
…H-105369) (#105453) typing: Improve documentation of generic classes and aliases (GH-105369) (cherry picked from commit d63a7c3) Co-authored-by: Alex Waygood <[email protected]>
JelleZijlstra
pushed a commit
that referenced
this pull request
Jun 7, 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.
The documentation for
typing.Dictcurrently describes the alias as:In 2023, this is pretty misleading: it implies that
dictis not generic, and that you have to usetyping.Dictif you want to supply type parameters. There are similar issues across the typing documentation for the various aliases that were deprecated as part of PEP-585.This PR also makes a few related edits to the docs for generic classes, which look like they still have some pre-PEP-585 language in them.
📚 Documentation preview 📚: https://cpython-previews--105369.org.readthedocs.build/