Skip to content

Commit

Permalink
[3.11] Minor improvements to typing docs (GH-104465) (#104475)
Browse files Browse the repository at this point in the history
Minor improvements to typing docs (GH-104465)
(cherry picked from commit 2f7b5e4)

Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
  • Loading branch information
miss-islington and JelleZijlstra authored May 14, 2023
1 parent 03f0d75 commit f5f9975
Showing 1 changed file with 6 additions and 4 deletions.
10 changes: 6 additions & 4 deletions Doc/library/typing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@

This module provides runtime support for type hints. The most fundamental
support consists of the types :data:`Any`, :data:`Union`, :data:`Callable`,
:class:`TypeVar`, and :class:`Generic`. For a full specification, please see
:class:`TypeVar`, and :class:`Generic`. For a specification, please see
:pep:`484`. For a simplified introduction to type hints, see :pep:`483`.


Expand Down Expand Up @@ -587,7 +587,7 @@ The module defines the following classes, functions and decorators.
when the checked program targets Python 3.9 or newer.

The deprecated types will be removed from the :mod:`typing` module
in the first Python version released 5 years after the release of Python 3.9.0.
no sooner than the first Python version released 5 years after the release of Python 3.9.0.
See details in :pep:`585`—*Type Hinting Generics In Standard Collections*.


Expand Down Expand Up @@ -1286,6 +1286,8 @@ These are not used in annotations. They are building blocks for creating generic
U = TypeVar('U', bound=str|bytes) # Can be any subtype of the union str|bytes
V = TypeVar('V', bound=SupportsAbs) # Can be anything with an __abs__ method

.. _typing-constrained-typevar:

Using a *constrained* type variable, however, means that the ``TypeVar``
can only ever be solved as being exactly one of the constraints given::

Expand Down Expand Up @@ -1528,7 +1530,7 @@ These are not used in annotations. They are building blocks for creating generic

.. data:: AnyStr

``AnyStr`` is a :class:`constrained type variable <TypeVar>` defined as
``AnyStr`` is a :ref:`constrained type variable <typing-constrained-typevar>` defined as
``AnyStr = TypeVar('AnyStr', str, bytes)``.

It is meant to be used for functions that may accept any kind of string
Expand Down Expand Up @@ -2072,7 +2074,7 @@ Other concrete types
Python 2 is no longer supported, and most type checkers also no longer
support type checking Python 2 code. Removal of the alias is not
currently planned, but users are encouraged to use
:class:`str` instead of ``Text`` wherever possible.
:class:`str` instead of ``Text``.

Abstract Base Classes
---------------------
Expand Down

0 comments on commit f5f9975

Please sign in to comment.