Skip to content

Tiny grammar corrections #14910

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 1 commit into from
Oct 22, 2025
Merged

Tiny grammar corrections #14910

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
12 changes: 6 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,10 @@
## About

Typeshed contains external type annotations for the Python standard library
and Python builtins, as well as third party packages as contributed by
and Python builtins, as well as third-party packages that are contributed by
Copy link
Member

@JelleZijlstra JelleZijlstra Oct 22, 2025

Choose a reason for hiding this comment

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

This sounds ungrammatical to me, should be "that have been", or just omit the "that are" part.

people external to those projects.

This data can e.g. be used for static analysis, type checking, type inference,
This data can, e.g., be used for static analysis, type checking, type inference,
and autocompletion.

For information on how to use typeshed, read below. Information for
Expand All @@ -29,8 +29,8 @@ If you're just using a type checker (e.g. [mypy](https://github.com/python/mypy/
[pyright](https://github.com/microsoft/pyright), or PyCharm's built-in type
checker), as opposed to
developing it, you don't need to interact with the typeshed repo at
all: a copy of standard library part of typeshed is bundled with type checkers.
And type stubs for third party packages and modules you are using can
all: a copy of the standard library part of typeshed is bundled with type checkers.
And type stubs for third-party packages and modules you are using can
be installed from PyPI. For example, if you are using `html5lib` and `requests`,
you can install the type stubs using

Expand Down Expand Up @@ -70,7 +70,7 @@ package you're using, each with its own tradeoffs:
type checking due to changes in the stubs.

Another risk of this strategy is that stubs often lag behind
the package being stubbed. You might want to force the package being stubbed
the package that is being stubbed. You might want to force the package being stubbed
Copy link
Member

@JelleZijlstra JelleZijlstra Oct 22, 2025

Choose a reason for hiding this comment

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

This reads better without "that is".

to a certain minimum version because it fixes a critical bug, but if
correspondingly updated stubs have not been released, your type
checking results may not be fully accurate.
Expand Down Expand Up @@ -119,6 +119,6 @@ a review of your type annotations or stubs outside of typeshed, head over to
[our discussion forum](https://github.com/python/typing/discussions).
For less formal discussion, try the typing chat room on
[gitter.im](https://gitter.im/python/typing). Some typeshed maintainers
are almost always present; feel free to find us there and we're happy
are almost always present; feel free to find us there, and we're happy
to chat. Substantive technical discussion will be directed to the
issue tracker.