Skip to content

Commit e703629

Browse files
README improvements (#250)
- The mention of testing in the README (which is what appears on PyPI) felt out of place. Replace it with a more general link to CONTRIBUTING. - Mention why typing-extensions is special. - Add discussion of stub files to CONTRIBUTING.
1 parent a65658f commit e703629

File tree

2 files changed

+15
-3
lines changed

2 files changed

+15
-3
lines changed

CONTRIBUTING.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,14 @@ Starting with version 4.0.0, `typing_extensions` uses
2626
[Semantic Versioning](https://semver.org/). See the documentation
2727
for more detail.
2828

29+
# Type stubs
30+
31+
A stub file for `typing_extensions` is maintained
32+
[in typeshed](https://github.com/python/typeshed/blob/main/stdlib/typing_extensions.pyi).
33+
Because of the special status that `typing_extensions` holds in the typing ecosystem,
34+
the stubs are placed in the standard library in typeshed and distributed as
35+
part of the stubs bundled with individual type checkers.
36+
2937
# Running tests
3038

3139
Testing `typing_extensions` can be tricky because many development tools depend on

README.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,10 @@ The `typing_extensions` module serves two related purposes:
1515
- Enable experimentation with new type system PEPs before they are accepted and
1616
added to the `typing` module.
1717

18+
`typing_extensions` is treated specially by static type checkers such as
19+
mypy and pyright. Objects defined in `typing_extensions` are treated the same
20+
way as equivalent forms in `typing`.
21+
1822
`typing_extensions` uses
1923
[Semantic Versioning](https://semver.org/). The
2024
major version will be incremented only for backwards-incompatible changes.
@@ -29,7 +33,7 @@ where `x.y` is the first version that includes all features you need.
2933
See [the documentation](https://typing-extensions.readthedocs.io/en/latest/#) for a
3034
complete listing of module contents.
3135

32-
## Running tests
36+
## Contributing
3337

34-
To run tests, navigate into the `src/` directory and run
35-
`test_typing_extensions.py`.
38+
See [CONTRIBUTING.md](https://github.com/python/typing_extensions/blob/main/CONTRIBUTING.md)
39+
for how to contribute to `typing_extensions`.

0 commit comments

Comments
 (0)