Fix error in t-suffixed-type-alias (PYI043) example
#8963
Merged
Conversation
This file contains 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
tjkuson
changed the title
t-suffixed-type-alias (PYI043) examplet-suffixed-type-alias (PYI043) example
tjkuson
force-pushed
the
pyi043-fix-docs
branch
from
9836afc to
c114521
Compare
|
charliermarsh
approved these changes
Dec 2, 2023
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.
Summary
For
t-suffixed-type-aliasto trigger, the type alias needs to be marked as such using thetyping.TypeAliasannotation and the name of the alias must be marked as private using a leading underscore. The documentation example was of an unannotated type alias that was not marked as private, which was misleading.Test Plan
The current example doesn't trigger the rule; the example in this merge request does.