Skip to content

Commit

Permalink
Expanded readme (python#1494)
Browse files Browse the repository at this point in the history
Expanded readme slightly by adding links to PEP 484 and proper markup for the code example
  • Loading branch information
JustusAdam authored and gvanrossum committed May 6, 2016
1 parent 52218bd commit 5410e5a
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,23 +9,23 @@ What is mypy?

Mypy is an optional static type checker for Python. You can add type
hints to your Python programs using the standard for type
annotations introduced in Python 3.5 (PEP 484), and use mypy to
annotations introduced in Python 3.5 ([PEP 484](https://www.python.org/dev/peps/pep-0484/)), and use mypy to
type check them statically. Find bugs in your programs without even
running them!

The type annotation standard has also been backported to earlier
Python 3.x versions. Mypy supports Python 3.2 and later.

For Python 2.7, you can add annotations as comments (this is also
specified in PEP 484).
specified in [PEP 484](https://www.python.org/dev/peps/pep-0484/)).

You can mix dynamic and static typing in your programs. You can always
fall back to dynamic typing when static typing is not convenient, such
as for legacy code.

Here is a small example to whet your appetite:

```
```python
from typing import Iterator

def fib(n: int) -> Iterator[int]:
Expand Down

0 comments on commit 5410e5a

Please sign in to comment.