Skip to content

Commit f94bbfb

Browse files
Update the README (#11553)
Read through the README and changed anything that no longer made sense. In particular, the documentation of our stub versioning scheme was outdated.
1 parent 2d146e7 commit f94bbfb

File tree

1 file changed

+10
-11
lines changed

1 file changed

+10
-11
lines changed

README.md

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,10 @@ Typeshed contains external type annotations for the Python standard library
1010
and Python builtins, as well as third party packages as contributed by
1111
people external to those projects.
1212

13-
This data can e.g. be used for static analysis, type checking or type inference.
13+
This data can e.g. be used for static analysis, type checking, type inference,
14+
and autocompletion.
1415

15-
For information on how to use `typeshed`, read below. Information for
16+
For information on how to use typeshed, read below. Information for
1617
contributors can be found in [CONTRIBUTING.md](CONTRIBUTING.md). **Please read
1718
it before submitting pull requests; do not report issues with annotations to
1819
the project the stubs are for, but instead report them here to typeshed.**
@@ -30,15 +31,15 @@ If you're just using a type checker ([mypy](https://github.com/python/mypy/),
3031
developing it, you don't need to interact with the typeshed repo at
3132
all: a copy of standard library part of typeshed is bundled with type checkers.
3233
And type stubs for third party packages and modules you are using can
33-
be installed from PyPI. For example, if you are using `six` and `requests`,
34+
be installed from PyPI. For example, if you are using `Pillow` and `requests`,
3435
you can install the type stubs using
3536

3637
```bash
37-
$ pip install types-six types-requests
38+
$ pip install types-Pillow types-requests
3839
```
3940

4041
These PyPI packages follow [PEP 561](http://www.python.org/dev/peps/pep-0561/)
41-
and are automatically released (multiple times a day, when needed) by
42+
and are automatically released (up to once a day) by
4243
[typeshed internal machinery](https://github.com/typeshed-internal/stub_uploader).
4344

4445
Type checkers should be able to use these stub packages when installed. For more
@@ -49,13 +50,11 @@ details, see the documentation for your type checker.
4950
Version numbers of third-party stub packages consist of at least four parts.
5051
All parts of the stub version, except for the last part, correspond to the
5152
version of the runtime package being stubbed. For example, if the `types-foo`
52-
package has version `1.2.0.7`, this guarantees that the `types-foo` package
53+
package has version `1.2.0.20240309`, this guarantees that the `types-foo` package
5354
contains stubs targeted against `foo==1.2.*` and tested against the latest
5455
version of `foo` matching that specifier. In this example, the final element
55-
of the version (7) indicates that this is the eighth revision of the stubs for
56-
`foo==1.2.*`. If an update to the stubs were pushed (but the stubs were still
57-
aiming to provide annotations for `foo==1.2.*`), then the version of
58-
`types-foo` would increment to `1.2.0.8`.
56+
of the version number (20240309) indicates that the stub package was pushed on
57+
March 9, 2024.
5958

6059
At typeshed, we try to keep breaking changes to a minimum. However, due to the
6160
nature of stubs, any version bump can introduce changes that might make your
@@ -100,7 +99,7 @@ a problem arises that can't easily be fixed.
10099
### The `_typeshed` package
101100

102101
typeshed includes a package `_typeshed` as part of the standard library.
103-
This package and its submodules contains utility types, but is not
102+
This package and its submodules contain utility types, but are not
104103
available at runtime. For more information about how to use this package,
105104
[see the `stdlib/_typeshed` directory](https://github.com/python/typeshed/tree/main/stdlib/_typeshed).
106105

0 commit comments

Comments
 (0)