Skip to content
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.

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

Fix error in t-suffixed-type-alias (PYI043) example #8963

Merged
merged 1 commit into from
Dec 2, 2023

Conversation

tjkuson
Copy link
Contributor

@tjkuson tjkuson commented Dec 2, 2023

Summary

For t-suffixed-type-alias to trigger, the type alias needs to be marked as such using the typing.TypeAlias annotation 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.

@tjkuson tjkuson changed the title Fix errort-suffixed-type-alias (PYI043) example Fix error in t-suffixed-type-alias (PYI043) example Dec 2, 2023
@tjkuson tjkuson marked this pull request as ready for review December 2, 2023 13:03
Copy link
Contributor

github-actions bot commented Dec 2, 2023

ruff-ecosystem results

Linter (stable)

✅ ecosystem check detected no linter changes.

Linter (preview)

✅ ecosystem check detected no linter changes.

@charliermarsh charliermarsh added the documentation Improvements or additions to documentation label Dec 2, 2023
@charliermarsh charliermarsh merged commit 35082b2 into astral-sh:main Dec 2, 2023
17 checks passed
@tjkuson tjkuson deleted the pyi043-fix-docs branch December 2, 2023 14:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants