Use the actual readme as the pyproject.toml readme#21166
Open
wyattscarpenter wants to merge 2 commits intopython:masterfrom
Open
Use the actual readme as the pyproject.toml readme#21166wyattscarpenter wants to merge 2 commits intopython:masterfrom
wyattscarpenter wants to merge 2 commits intopython:masterfrom
Conversation
Fixes python#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?
This comment has been minimized.
This comment has been minimized.
…the relative link
Contributor
|
According to mypy_primer, this change doesn't affect type check results on a corpus of open source code. ✅ |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes #12456, making the pypi project page readme much less bare-bones. It uses this pyproject,toml field, which we were already using: https://packaging.python.org/en/latest/guides/writing-pyproject-toml/#readme
Since our readme started by jumping right into the "Got a question?" section, I copied the description that used to be on the pypi page into our readme to be a little orienting summary right after before that.
I also changed the relative link to CONTRIBUTING.md to be a non-relative link, so it will work on pypi as well.