Clarify stub-only packages need to be installed #9958
Merged
Conversation
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
JukkaL
reviewed
Nov 25, 2021
tushar-deepsource
pushed a commit
to DeepSourceCorp/mypy
that referenced
this pull request
Jan 20, 2022
* Clarify stub-only packages need to be installed * Add link to PEP 561
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description
Reading the documentation about how imports are found, I was confused by the note:
"You cannot point to a PEP 561 package via the
MYPYPATH, it must be installed (see PEP 561 support)".I did not know what a PEP 561 package was, so I went to skim the documentation. This did not make me much wiser, since it describes multiple ways of distributing type hints, e.g. by providing the
py.typedfile. From PEP 561 support it seems like what is actually referred to is specifically stub-only packages (also introduced in PEP 561).This PR changes the note to:
"You cannot point to a stub-only package via the
MYPYPATH, it must be installed (see PEP 561 support)".Test Plan
Rebuilding docs creates expected results.