Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Use the actual readme as the pyproject.toml readme #21166

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wyattscarpenter wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Use the actual readme as the pyproject.toml readme #21166

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a71506c
Use the actual readme as the readme
wyattscarpenter Apr 4, 2026
e7f26e1
Update README.md: add the summary description to the readme, and fix …
wyattscarpenter Apr 4, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
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?
  • Loading branch information
@wyattscarpenter
wyattscarpenter authored Apr 4, 2026
commit a71506ccd054cbf46684011ed43c52e3d1e94ebe
12 changes: 1 addition & 11 deletions pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,17 +19,7 @@ build-backend = "setuptools.build_meta"
[project]
name = "mypy"
description = "Optional static typing for Python"
readme = {text = """
Mypy -- Optional Static Typing for Python
=========================================

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.
""", content-type = "text/x-rst"}
readme = "README.md"
authors = [{name = "Jukka Lehtosalo", email = "[email protected]"}]
license = "MIT"
license-files = ["LICENSE", "mypy/typeshed/LICENSE"]
Expand Down
Loading