Skip to content
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

docs(typing): harmonize "See PEP x for more details" #97927

Merged
merged 1 commit into from
Oct 15, 2022
Merged

docs(typing): harmonize "See PEP x for more details" #97927

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
18 changes: 8 additions & 10 deletions Doc/library/typing.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -248,7 +248,7 @@ respectively.

.. versionchanged:: 3.10
``Callable`` now supports :class:`ParamSpec` and :data:`Concatenate`.
See :pep:`612` for more information.
See :pep:`612` for more details.

.. seealso::
The documentation for :class:`ParamSpec` and :class:`Concatenate` provides
Expand Down Expand Up @@ -721,7 +721,7 @@ These can be used as types in annotations and do not support ``[]``.
of the ``cls`` parameter.
- Annotating an :meth:`~object.__enter__` method which returns self.

For more information, see :pep:`673`.
See :pep:`673` for more details.

.. versionadded:: 3.11

Expand Down Expand Up @@ -852,7 +852,7 @@ These can be used as types in annotations using ``[]``, each having a unique syn

.. versionchanged:: 3.10
``Callable`` now supports :class:`ParamSpec` and :data:`Concatenate`.
See :pep:`612` for more information.
See :pep:`612` for more details.

.. seealso::
The documentation for :class:`ParamSpec` and :class:`Concatenate` provide
Expand Down Expand Up @@ -1038,8 +1038,7 @@ These can be used as types in annotations using ``[]``, each having a unique syn
Special typing constructs that mark individual keys of a :class:`TypedDict`
as either required or non-required respectively.

For more information, see :class:`TypedDict` and
:pep:`655` ("Marking individual TypedDict items as required or potentially missing").
See :class:`TypedDict` and :pep:`655` for more details.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

The names of the PEPs are already spelled out in the section "Relevant PEPs".


.. versionadded:: 3.11

Expand Down Expand Up @@ -1190,8 +1189,7 @@ These can be used as types in annotations using ``[]``, each having a unique syn
is not a subtype of the former, since ``list`` is invariant.
The responsibility of writing type-safe type guards is left to the user.

``TypeGuard`` also works with type variables. For more information, see
:pep:`647` (User-Defined Type Guards).
``TypeGuard`` also works with type variables. See :pep:`647` for more details.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

The names of the PEPs are already spelled out in the section "Relevant PEPs".


.. versionadded:: 3.10

Expand Down Expand Up @@ -1391,7 +1389,7 @@ These are not used in annotations. They are building blocks for creating generic
to ``call_soon`` match the types of the (positional) arguments of
``callback``.

For more details on type variable tuples, see :pep:`646`.
See :pep:`646` for more details on type variable tuples.

.. versionadded:: 3.11

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

func(C()) # Passes static type check

See :pep:`544` for details. Protocol classes decorated with
See :pep:`544` for more details. Protocol classes decorated with
:func:`runtime_checkable` (described later) act as simple-minded runtime
protocols that check only the presence of given attributes, ignoring their
type signatures.
Expand Down Expand Up @@ -2630,7 +2628,7 @@ Functions and decorators
def process(response):
<actual implementation>

See :pep:`484` for details and comparison with other typing semantics.
See :pep:`484` for more details and comparison with other typing semantics.

.. versionchanged:: 3.11
Overloaded functions can now be introspected at runtime using
Expand Down