From: Miss Islington (bot) <31488909+miss-islington@users.noreply.github.com> Date: Thu, 4 Nov 2021 04:34:31 +0000 (-0700) Subject: bpo-45680: ``typing`` docs: improve links to docs on ``GenericAlias``/``__class_getit... X-Git-Tag: v3.9.8~10 X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=e813dd4d7bb0ecfabc7dae75e13f58164bcf8da6;p=thirdparty%2FPython%2Fcpython.git bpo-45680: ``typing`` docs: improve links to docs on ``GenericAlias``/``__class_getitem__`` (GH-29387) (cherry picked from commit e03e50377d6f8f212af60fed4ae405ebeb73237d) Co-authored-by: Alex Waygood --- diff --git a/Doc/library/typing.rst b/Doc/library/typing.rst index 295f2ae8905a..068112d8d945 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* :class:`Literal` * :pep:`589`: TypedDict: Type Hints for Dictionaries with a Fixed Set of Keys @@ -258,8 +258,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 000000000000..79ea6e308e54 --- /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.