[3.10] [doc] bpo-45680: Disambiguate __getitem__ and __class_getitem__ in the data model (GH-29389)
#29620
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
…`` in the data model (pythonGH-29389) The documentation explaining Python's data model does not adequately explain the differences between ``__getitem__`` and ``__class_getitem__``, nor does it explain when each is called. There is an attempt at explaining ``__class_getitem__`` in the documentation for ``GenericAlias`` objects, but this does not give sufficient clarity into how the method works. Moreover, it is the wrong place for that information to be found; the explanation of ``__class_getitem__`` should be in the documentation explaining the data model. This PR has been split off from pythonGH-29335. (cherry picked from commit 31b3a70) Co-authored-by: Alex Waygood <[email protected]>
miss-islington
requested review from
Fidget-Spinner and
gvanrossum
as code owners
Contributor
Author
|
@AlexWaygood and @ambv: Status check is done, and it's a failure ❌ . |
Contributor
Author
|
@AlexWaygood and @ambv: Status check is done, and it's a success ✅ . |
Contributor
Author
|
@AlexWaygood and @ambv: 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 explaining Python's data model does not adequately explain
the differences between
__getitem__and__class_getitem__, nor does itexplain when each is called. There is an attempt at explaining
__class_getitem__in the documentation forGenericAliasobjects, butthis does not give sufficient clarity into how the method works. Moreover, it
is the wrong place for that information to be found; the explanation of
__class_getitem__should be in the documentation explaining the data model.This PR has been split off from GH-29335.
(cherry picked from commit 31b3a70)
Co-authored-by: Alex Waygood [email protected]
https://bugs.python.org/issue45680