Skip to content

Documentation on GenericAlias objects and __class_getitem__ could be improved #89843

Closed
Closed
Documentation on GenericAlias objects and __class_getitem__ could be improved#89843
Labels
3.10 (EOL)end of life3.11only security fixes3.9 (EOL)end of lifedocsDocumentation in the Doc dirtype-bugAn unexpected behavior, bug, or error

Description

@AlexWaygood
AlexWaygood
opened on Oct 30, 2021
BPO 45680
Nosy @gvanrossum, @ambv, @JelleZijlstra, @miss-islington, @Fidget-Spinner, @AlexWaygood
PRs
  • bpo-45680: Clarify documentation on GenericAlias objects #29335
  • bpo-45680: typing docs: improve links to docs on GenericAlias/__class_getitem__ #29387
  • [doc] bpo-45680: Improve glossary entry for generic types #29388
  • [doc] bpo-45680: Disambiguate __getitem__ and __class_getitem__ in the data model. #29389
  • [3.10] bpo-45680: typing docs: improve links to docs on GenericAlias/__class_getitem__ (GH-29387) #29399
  • [3.9] bpo-45680: typing docs: improve links to docs on GenericAlias/__class_getitem__ (GH-29387) #29400
  • [3.10] [doc] bpo-45680: Improve glossary entry for generic types (GH-29388) #29447
  • [3.9] [doc] bpo-45680: Improve glossary entry for generic types (GH-29388) #29448
  • bpo-45680: Improve docs on subscriptions w.r.t. GenericAlias objects #29479
  • [3.9] [doc] bpo-45680: Disambiguate __getitem__ and __class_getitem__ in the data model (GH-29389) #29619
  • [3.10] [doc] bpo-45680: Disambiguate __getitem__ and __class_getitem__ in the data model (GH-29389) #29620
  • [3.10] bpo-45680: Clarify documentation on GenericAlias objects (GH-29335) #30688
  • [3.9] bpo-45680: Clarify documentation on GenericAlias objects (GH-29335) #30689
  • bpo-45680: Minor formatting fix in stdtypes.rst #30690
  • [3.10] bpo-45680: Improve docs on subscriptions w.r.t. GenericAlias objects (GH-29479) #31743
  • [3.9] bpo-45680: Improve docs on subscriptions w.r.t. GenericAlias objects (GH-29479) #31744
    		•

    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']

    Activity

    1. AlexWaygood commented on Oct 30, 2021

      @AlexWaygood
      AlexWaygood
      on Oct 30, 2021
      MemberAuthor

      The documentation on GenericAlias objects 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.

    2. AlexWaygood
      added
      3.9 (EOL)end of life
      3.10 (EOL)end of life
      3.11only security fixes
      on Oct 30, 2021
    3. AlexWaygood
      assigned
      docspython
      on Oct 30, 2021
    4. AlexWaygood
      added
      docsDocumentation in the Doc dir
      3.9 (EOL)end of life
      type-bugAn unexpected behavior, bug, or error
      3.10 (EOL)end of life
      3.11only security fixes
      on Oct 30, 2021
    5. AlexWaygood
      assigned
      docspython
      on Oct 30, 2021
    6. AlexWaygood
      added
      docsDocumentation in the Doc dir
      type-bugAn unexpected behavior, bug, or error
      on Oct 30, 2021

    7. AlexWaygood commented on Oct 30, 2021

      @AlexWaygood
      AlexWaygood
      on Oct 30, 2021
      MemberAuthor

      This issue is related, but distinct, to previous issue https://bugs.python.org/issue42280.

    8. AlexWaygood
      changed the title [-]Documentation on `GenericAlias` objects could be improved[/-] [+]Documentation on `GenericAlias` objects and `__class_getitem__` could be improved[/+] on Nov 3, 2021

    9. 15 remaining items

    10. Fidget-Spinner
      closed this as completedon Jan 19, 2022
    11. Fidget-Spinner
      closed this as completedon Jan 19, 2022

    12. AlexWaygood commented on Jan 19, 2022

      @AlexWaygood
      AlexWaygood
      on Jan 19, 2022
      MemberAuthor

      Wait... there's still PR 29479 open!

      But that can wait a little while -- getting PR 29335 over the line is definitely worth celebrating!!

    13. Fidget-Spinner commented on Jan 24, 2022

      @Fidget-Spinner
      Fidget-Spinner
      on Jan 24, 2022
      Member

      Wait... there's still PR 29479 open!

      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!

    14. Fidget-Spinner
      reopened this on Jan 24, 2022
    15. Fidget-Spinner
      reopened this on Jan 24, 2022

    16. AlexWaygood commented on Jan 24, 2022

      @AlexWaygood
      AlexWaygood
      on Jan 24, 2022
      MemberAuthor

      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!

      No worries — will do!

    17. JelleZijlstra commented on Mar 8, 2022

      @JelleZijlstra
      JelleZijlstra
      on Mar 8, 2022
      Member

      New changeset 5073129 by Alex Waygood in branch 'main':
      bpo-45680: Improve docs on subscriptions w.r.t. GenericAlias objects (GH-29479)
      5073129

    18. JelleZijlstra commented on Mar 8, 2022

      @JelleZijlstra
      JelleZijlstra
      on Mar 8, 2022
      Member

      And now I think we're really done! Thanks for all your work here @AlexWaygood.

    19. JelleZijlstra
      closed this as completedon Mar 8, 2022
    20. JelleZijlstra
      closed this as completedon Mar 8, 2022

    21. miss-islington commented on Mar 8, 2022

      @miss-islington
      miss-islington
      on Mar 8, 2022
      Contributor

      New changeset 06108c0 by Miss Islington (bot) in branch '3.10':
      bpo-45680: Improve docs on subscriptions w.r.t. GenericAlias objects (GH-29479)
      06108c0

    22. miss-islington commented on Mar 8, 2022

      @miss-islington
      miss-islington
      on Mar 8, 2022
      Contributor

      New changeset e83f084 by Miss Islington (bot) in branch '3.9':
      bpo-45680: Improve docs on subscriptions w.r.t. GenericAlias objects (GH-29479)
      e83f084

    23. AlexWaygood commented on Mar 8, 2022

      @AlexWaygood
      AlexWaygood
      on Mar 8, 2022
      MemberAuthor

      Thanks so much to Ken, Łukasz, Jelle, Guido, and everybody else who helped review these PRs!

    24. ezio-melotti
      transferred this issue fromon Apr 10, 2022
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

    Metadata

    Metadata

    Assignees

    No one assigned

      Labels

      3.10 (EOL)end of life3.11only security fixes3.9 (EOL)end of lifedocsDocumentation in the Doc dirtype-bugAn unexpected behavior, bug, or error

      Projects

      No projects

        Milestone

        No milestone

        Relationships

        None yet

        Development

        No branches or pull requests

        Issue actions