Skip to content

Rephrase typing.assert_never docs #92061

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
merged 2 commits into from
Apr 30, 2022
Merged

Rephrase typing.assert_never docs #92061

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
189456d
Rephrase typing.assert_never docs
hauntsaninja Apr 29, 2022
414caca
additional reword from alexwaygood
hauntsaninja Apr 29, 2022
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
4 changes: 2 additions & 2 deletions Doc/library/typing.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2337,7 +2337,7 @@ Functions and decorators

.. function:: assert_never(arg, /)

Assert to the type checker that a line of code is unreachable.
Ask a static type checker to confirm that a line of code is unreachable.

Example::

Expand All @@ -2358,7 +2358,7 @@ Functions and decorators
reachable, it will emit an error. For example, if the type annotation
for ``arg`` was instead ``int | str | float``, the type checker would
emit an error pointing out that ``unreachable`` is of type :class:`float`.
For a call to ``assert_never`` to succeed, the inferred type of
For a call to ``assert_never`` to pass type checking, the inferred type of
the argument passed in must be the bottom type, :data:`Never`, and nothing
else.

Expand Down