Skip to content

Commit 77938e0

Browse files
authored
README.md: rearrange first paragraph to be more friendly
1 parent c858914 commit 77938e0

File tree

1 file changed

+13
-11
lines changed

1 file changed

+13
-11
lines changed

README.md

Lines changed: 13 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -25,17 +25,8 @@ What is mypy?
2525
-------------
2626

2727
Mypy is an optional static type checker for Python. You can add type
28-
hints to your Python programs using the standard for type
29-
annotations introduced in Python 3.5 ([PEP 484](https://www.python.org/dev/peps/pep-0484/)), and use mypy to
30-
type check them statically. Find bugs in your programs without even
31-
running them!
32-
33-
The type annotation standard has also been backported to earlier
34-
Python 3.x versions. Mypy supports Python 3.3 and later.
35-
XML based reports do not work on Python 3.3 and 3.4 on Windows.
36-
37-
For Python 2.7, you can add annotations as comments (this is also
38-
specified in [PEP 484](https://www.python.org/dev/peps/pep-0484/)).
28+
hints to your Python programs, and use mypy to type check them statically.
29+
Find bugs in your programs without even running them!
3930

4031
You can mix dynamic and static typing in your programs. You can always
4132
fall back to dynamic typing when static typing is not convenient, such
@@ -56,6 +47,17 @@ def fib(n: int) -> Iterator[int]:
5647
Mypy is in development; some features are missing and there are bugs.
5748
See 'Development status' below.
5849

50+
Annotations
51+
-----------
52+
You can add type hints to your Python programs using the standard for type
53+
annotations introduced in Python 3.5 ([PEP 484](https://www.python.org/dev/peps/pep-0484/)).
54+
The type annotation standard has also been backported to earlier
55+
Python 3.x versions. Mypy supports Python 3.3 and later.
56+
XML based reports do not work on Python 3.3 and 3.4 on Windows.
57+
58+
For Python 2.7, you can add annotations as comments (this is also
59+
specified in [PEP 484](https://www.python.org/dev/peps/pep-0484/)).
60+
5961

6062
Requirements
6163
------------

0 commit comments

Comments
 (0)