Skip to content

Commit a71506c

Browse files
Use the actual readme as the readme
Fixes #12456 Things to consider: Our current readme starts with "Got a question?". We could start with a short description instead, copying in our current description paragraph: 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." Occasionally there is a relative link, like [CONTRIBUTING.md](CONTRIBUTING.md). Do those need to be changed?
1 parent 3cda6ec commit a71506c

File tree

1 file changed

+1
-11
lines changed

1 file changed

+1
-11
lines changed

pyproject.toml

Lines changed: 1 addition & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -19,17 +19,7 @@ build-backend = "setuptools.build_meta"
1919
[project]
2020
name = "mypy"
2121
description = "Optional static typing for Python"
22-
readme = {text = """
23-
Mypy -- Optional Static Typing for Python
24-
=========================================
25-
26-
Add type annotations to your Python programs, and use mypy to type
27-
check them. Mypy is essentially a Python linter on steroids, and it
28-
can catch many programming errors by analyzing your program, without
29-
actually having to run it. Mypy has a powerful type system with
30-
features such as type inference, gradual typing, generics and union
31-
types.
32-
""", content-type = "text/x-rst"}
22+
readme = "README.md"
3323
authors = [{name = "Jukka Lehtosalo", email = "jukka.lehtosalo@iki.fi"}]
3424
license = "MIT"
3525
license-files = ["LICENSE", "mypy/typeshed/LICENSE"]

0 commit comments

Comments
 (0)