Skip to content

Commit 7d47c9f

Browse files
authored
Rework README (#853)
* Rename to "Static Typing for Python". * Add "Documentation and Support" section. * Update what the repository is used for.
1 parent 651cb58 commit 7d47c9f

File tree

1 file changed

+28
-9
lines changed

1 file changed

+28
-9
lines changed

README.md

Lines changed: 28 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,40 @@
11
[![Chat at https://gitter.im/python/typing](https://badges.gitter.im/python/typing.svg)](https://gitter.im/python/typing?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
22

3-
PEP 484: Type Hints
4-
===================
3+
Static Typing for Python
4+
========================
55

6-
This GitHub repo is used for three separate things:
6+
Documentation and Support
7+
-------------------------
78

8-
- The issue tracker is used to discuss PEP-level type system issues.
9-
However,
10-
[typing-sig](https://mail.python.org/mailman3/lists/typing-sig.python.org/)
11-
is more appropriate these days.
9+
The documentation for Python's static typing can be found at
10+
[typing.readthedocs.io](https://typing.readthedocs.io/). You can get
11+
help either in our [support forum](/python/typing/discussions) or
12+
chat with us on (Gitter)[https://gitter.im/python/typing].
13+
14+
Improvements to the type system should be discussed on the
15+
[typing-sig](https://mail.python.org/mailman3/lists/typing-sig.python.org/)
16+
mailing list, although the [issues](/python/typing/issues) in this
17+
repository contain some historic discussions.
18+
19+
Repository Content
20+
------------------
21+
22+
This GitHub repo is used for several things:
1223

1324
- A backport of the `typing` module for older Python versions (2.7 and
14-
3.4) is maintained here. Note that the canonical source lives
25+
3.4) is maintained in the [src directory](./src).
26+
Note that the canonical source lives
1527
[upstream](https://github.com/python/cpython/blob/master/Lib/typing.py)
1628
in the CPython repo.
1729

18-
- The `typing_extensions` module lives here.
30+
- The `typing_extensions` module lives in the
31+
[typing\_extensions](./typing_extensions) directory.
32+
33+
- The documentation at [typing.readthedocs.io](https://typing.readthedocs.io/)
34+
is maintained in the [docs directory](./docs).
35+
36+
- A [discussion forum](/python/typing/discussions) for typing-related user
37+
help is hosted here.
1938

2039
Workflow
2140
--------

0 commit comments

Comments
 (0)