Skip to content

bpo-45680: typing docs: improve links to docs on GenericAlias/__class_getitem__ #29387

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Fidget-Spinner merged 2 commits into from
Nov 4, 2021
Merged

bpo-45680: typing docs: improve links to docs on GenericAlias/__class_getitem__ #29387

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6f5af22
bpo-45680: ``typing`` docs: improve links to docs on ``GenericAlias``…
AlexWaygood Nov 3, 2021
449fad9
Improve new entry
AlexWaygood Nov 3, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions Doc/library/typing.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,8 +49,8 @@ annotations. These include:
*Introducing* :class:`Protocol` and the
:func:`@runtime_checkable<runtime_checkable>` decorator
* :pep:`585`: Type Hinting Generics In Standard Collections
*Introducing* the ability to use builtin collections and ABCs as
:term:`generic types<generic type>`
*Introducing* :class:`types.GenericAlias` and the ability to use standard
library classes as :ref:`generic types<types-genericalias>`

@Fidget-Spinner Fidget-Spinner Nov 3, 2021

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Wait, why'd the link change from the one in the glossary to about types-genericalias?

@AlexWaygood AlexWaygood Nov 3, 2021

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

My reasoning was:

  • I think the types-genericalias link is more informative about the change that was introduced in the PEP.
  • I think it's an important piece of documentation that deserves a prominent mention near the top of the typing docs.
  • It's consistent with the link to types-union in the bullet point about PEP 604.

But I'm very happy to revert this change if you think the link to the glossary is more appropriate here 🙂

* :pep:`586`: Literal Types
*Introducing* :data:`Literal`
* :pep:`589`: TypedDict: Type Hints for Dictionaries with a Fixed Set of Keys
Expand Down Expand Up @@ -291,8 +291,8 @@ A user-defined class can be defined as a generic class.
single type parameter ``T`` . This also makes ``T`` valid as a type within the
class body.

The :class:`Generic` base class defines :meth:`__class_getitem__` so that
``LoggedVar[t]`` is valid as a type::
The :class:`Generic` base class defines :meth:`~object.__class_getitem__` so
that ``LoggedVar[t]`` is valid as a type::

from collections.abc import Iterable

Expand Down
3 changes: 3 additions & 0 deletions Misc/NEWS.d/next/Documentation/2021-11-03-14-51-03.bpo-45680.9_NTFU.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
Amend the docs on ``GenericAlias`` objects to clarify that non-container
classes can also implement ``__class_getitem__``. Patch contributed by Alex
Waygood.