Skip to content

docs: improve clarity and fix typos in type narrowing guide #2271

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
davidhalter merged 2 commits into from
May 15, 2026
+2 −2
Merged

docs: improve clarity and fix typos in type narrowing guide #2271

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
351fec7
docs: fix typo and grammar in type narrowing guide
BHUVANSH855 May 15, 2026
7f3cc8d
Merge branch 'main' into docs/improve-type-narrowing-wording
BHUVANSH855 May 15, 2026
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 docs/guides/type_narrowing.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ For example::
print(f"{x} is not a cardinal direction")

A ``TypeGuard`` function looks similar and is used in the same way, but the
type narrowing behavior is different, as dicussed in :ref:`the section below <guide-type-narrowing-typeis-typeguard>`.
type narrowing behavior is different, as discussed in :ref:`the section below <guide-type-narrowing-typeis-typeguard>`.

Depending on the version of Python you are running, you will be able to
import ``TypeIs`` and ``TypeGuard`` either from the standard library :py:mod:`typing`
Expand Down Expand Up @@ -143,7 +143,7 @@ Here is an example of a correct ``TypeIs`` function for a more complicated type:
:py:data:`typing.TypeIs` and :py:data:`typing.TypeGuard` are both tools for narrowing the type of a variable
based on a user-defined function. Both can be used to annotate functions that take an
argument and return a boolean depending on whether the input argument is compatible with
the narrowed type. These function can then be used in ``if`` checks to narrow the type
the narrowed type. These functions can then be used in ``if`` checks to narrow the type
of a variable.

``TypeIs`` usually has the more intuitive behavior, but it
Expand Down