[3.10] bpo-45680: Clarify documentation on GenericAlias objects (GH-29335)
#30688
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
…H-29335) The documentation on ``GenericAlias`` objects implies at multiple points that only container classes can define ``__class_getitem__``. This is misleading. This PR proposes a rewrite of the documentation to clarify that non-container classes can define ``__class_getitem__``, and to clarify what it means when a non-container class is parameterized. See also: initial discussion of issues with this piece of documentation in pythonGH-29308, and previous BPO issue [42280](https://bugs.python.org/issue42280). Also improved references in glossary and typing docs. Fixed some links. Co-authored-by: Erlend Egeberg Aasland <[email protected]> Co-authored-by: Ken Jin <[email protected]> (cherry picked from commit 0eae9a2) Co-authored-by: Alex Waygood <[email protected]>
Contributor
Author
|
@AlexWaygood and @Fidget-Spinner: Status check is done, and it's a failure ❌ . |
Contributor
Author
|
@AlexWaygood and @Fidget-Spinner: Status check is done, and it's a success ✅ . |
Fidget-Spinner
approved these changes
Jan 19, 2022
Contributor
Author
|
@AlexWaygood and @Fidget-Spinner: Status check is done, and it's a success ✅ . |
Contributor
Author
|
Sorry, I can't merge this PR. Reason: |
Contributor
Author
|
@miss-islington: Status check is done, and it's a success ✅ . |
Contributor
Author
|
@AlexWaygood and @Fidget-Spinner: Status check is done, and it's a success ✅ . |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 participants
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 on
GenericAliasobjects implies at multiple points thatonly container classes can define
__class_getitem__. This is misleading.This PR proposes a rewrite of the documentation to clarify that non-container
classes can define
__class_getitem__, and to clarify what it means when anon-container class is parameterized.
See also: initial discussion of issues with this piece of documentation in
GH-29308, and previous BPO issue 42280.
Also improved references in glossary and typing docs. Fixed some links.
Co-authored-by: Erlend Egeberg Aasland [email protected]
Co-authored-by: Ken Jin [email protected]
(cherry picked from commit 0eae9a2)
Co-authored-by: Alex Waygood [email protected]
https://bugs.python.org/issue45680
Automerge-Triggered-By: GH:Fidget-Spinner