From c10896696f47a8348e6d9ea3c1d96fa6ba131a31 Mon Sep 17 00:00:00 2001 From: "Miss Islington (bot)" <31488909+miss-islington@users.noreply.github.com> Date: Wed, 3 Nov 2021 21:27:47 -0700 Subject: bpo-45680: ``typing`` docs: improve links to docs on ``GenericAlias``/``__class_getitem__`` (GH-29387) (cherry picked from commit e03e50377d6f8f212af60fed4ae405ebeb73237d) Co-authored-by: Alex Waygood --- Doc/library/typing.rst | 8 ++++---- .../next/Documentation/2021-11-03-14-51-03.bpo-45680.9_NTFU.rst | 3 +++ 2 files changed, 7 insertions(+), 4 deletions(-) create mode 100644 Misc/NEWS.d/next/Documentation/2021-11-03-14-51-03.bpo-45680.9_NTFU.rst diff --git a/Doc/library/typing.rst b/Doc/library/typing.rst index 7652c87..db9ad11 100644 --- a/Doc/library/typing.rst +++ b/Doc/library/typing.rst @@ -49,8 +49,8 @@ annotations. These include: *Introducing* :class:`Protocol` and the :func:`@runtime_checkable` decorator * :pep:`585`: Type Hinting Generics In Standard Collections - *Introducing* the ability to use builtin collections and ABCs as - :term:`generic types` + *Introducing* :class:`types.GenericAlias` and the ability to use standard + library classes as :ref:`generic types` * :pep:`586`: Literal Types *Introducing* :data:`Literal` * :pep:`589`: TypedDict: Type Hints for Dictionaries with a Fixed Set of Keys @@ -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 diff --git a/Misc/NEWS.d/next/Documentation/2021-11-03-14-51-03.bpo-45680.9_NTFU.rst b/Misc/NEWS.d/next/Documentation/2021-11-03-14-51-03.bpo-45680.9_NTFU.rst new file mode 100644 index 0000000..79ea6e3 --- /dev/null +++ b/Misc/NEWS.d/next/Documentation/2021-11-03-14-51-03.bpo-45680.9_NTFU.rst @@ -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. -- cgit v0.12