Skip to content

Commit e7f26e1

Browse files
Update README.md: add the summary description to the readme, and fix the relative link
1 parent a71506c commit e7f26e1

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

README.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,8 @@ Mypy: Static Typing for Python
1212
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
1313
[![Linting: Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/charliermarsh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
1414

15+
Add type annotations to your Python programs, and use mypy to type check them. Mypy is essentially a Python linter on steroids, and it can catch many programming errors by analyzing your program, without actually having to run it. Mypy has a powerful type system with features such as type inference, gradual typing, generics and union types.
16+
1517
Got a question?
1618
---------------
1719

@@ -168,7 +170,8 @@ Help in testing, development, documentation and other tasks is
168170
highly appreciated and useful to the project. There are tasks for
169171
contributors of all experience levels.
170172

171-
To get started with developing mypy, see [CONTRIBUTING.md](CONTRIBUTING.md).
173+
To get started with developing mypy, see
174+
[CONTRIBUTING.md](https://github.com/python/mypy/blob/master/CONTRIBUTING.md).
172175

173176
Mypyc and compiled version of mypy
174177
----------------------------------

0 commit comments

Comments
 (0)