Repository navigation
Documentation on GenericAlias objects and __class_getitem__ could be improved #89843
Copy link
Copy link
Closed
Labels
3.10 (EOL)end of lifeend of life3.11only security fixesonly security fixes3.9 (EOL)end of lifeend of lifedocsDocumentation in the Doc dirDocumentation in the Doc dirtype-bugAn unexpected behavior, bug, or errorAn unexpected behavior, bug, or error
Description
Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.
Show more details
GitHub fields:
assignee = None
closed_at = <Date 2022-03-08.03:59:23.108>
created_at = <Date 2021-10-30.20:21:29.476>
labels = ['3.11', 'type-bug', '3.9', '3.10', 'docs']
title = 'Documentation on `GenericAlias` objects and `__class_getitem__` could be improved'
updated_at = <Date 2022-03-08.07:55:01.501>
user = 'https://github.com/AlexWaygood'bugs.python.org fields:
activity = <Date 2022-03-08.07:55:01.501>
actor = 'AlexWaygood'
assignee = 'docs@python'
closed = True
closed_date = <Date 2022-03-08.03:59:23.108>
closer = 'JelleZijlstra'
components = ['Documentation']
creation = <Date 2021-10-30.20:21:29.476>
creator = 'AlexWaygood'
dependencies = []
files = []
hgrepos = []
issue_num = 45680
keywords = ['patch']
message_count = 24.0
messages = ['405384', '405385', '405662', '405664', '405665', '405871', '405876', '405878', '406542', '406557', '406558', '410954', '410956', '410959', '410966', '410967', '410969', '411489', '411490', '414712', '414714', '414718', '414719', '414730']
nosy_count = 7.0
nosy_names = ['gvanrossum', 'docs@python', 'lukasz.langa', 'JelleZijlstra', 'miss-islington', 'kj', 'AlexWaygood']
pr_nums = ['29335', '29387', '29388', '29389', '29399', '29400', '29447', '29448', '29479', '29619', '29620', '30688', '30689', '30690', '31743', '31744']
priority = 'normal'
resolution = 'fixed'
stage = 'resolved'
status = 'closed'
superseder = None
type = 'behavior'
url = 'https://bugs.python.org/issue45680'
versions = ['Python 3.9', 'Python 3.10', 'Python 3.11']Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
3.10 (EOL)end of lifeend of life3.11only security fixesonly security fixes3.9 (EOL)end of lifeend of lifedocsDocumentation in the Doc dirDocumentation in the Doc dirtype-bugAn unexpected behavior, bug, or errorAn unexpected behavior, bug, or error
Activity
AlexWaygood commentedon Oct 30, 2021
The documentation on
GenericAliasobjects implies at multiple points that only container classes can implement__class_getitem__, and goes into very little detail about what it means for a non-container class to be parameterized.AlexWaygood commentedon Oct 30, 2021
This issue is related, but distinct, to previous issue https://bugs.python.org/issue42280.
[-]Documentation on `GenericAlias` objects could be improved[/-][+]Documentation on `GenericAlias` objects and `__class_getitem__` could be improved[/+]15 remaining items
AlexWaygood commentedon Jan 19, 2022
Wait... there's still PR 29479 open!
But that can wait a little while -- getting PR 29335 over the line is definitely worth celebrating!!
Fidget-Spinner commentedon Jan 24, 2022
Sorry, I was too excited when PR 29335 merged and missed that. In the future, please re-open if you feel I closed an issue wrongly. Thanks!
AlexWaygood commentedon Jan 24, 2022
No worries — will do!
JelleZijlstra commentedon Mar 8, 2022
New changeset 5073129 by Alex Waygood in branch 'main':
bpo-45680: Improve docs on subscriptions w.r.t.
GenericAliasobjects (GH-29479)5073129
JelleZijlstra commentedon Mar 8, 2022
And now I think we're really done! Thanks for all your work here @AlexWaygood.
miss-islington commentedon Mar 8, 2022
New changeset 06108c0 by Miss Islington (bot) in branch '3.10':
bpo-45680: Improve docs on subscriptions w.r.t.
GenericAliasobjects (GH-29479)06108c0
miss-islington commentedon Mar 8, 2022
New changeset e83f084 by Miss Islington (bot) in branch '3.9':
bpo-45680: Improve docs on subscriptions w.r.t.
GenericAliasobjects (GH-29479)e83f084
AlexWaygood commentedon Mar 8, 2022
Thanks so much to Ken, Łukasz, Jelle, Guido, and everybody else who helped review these PRs!