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

Pylint subcategories' codes are confusingly documented #15168

Open
Avasam opened this issue Dec 28, 2024 · 1 comment
Open

Pylint subcategories' codes are confusingly documented #15168

Avasam opened this issue Dec 28, 2024 · 1 comment
Labels
documentation Improvements or additions to documentation help wanted Contributions especially welcome

Comments

@Avasam
Copy link
Contributor

Avasam commented Dec 28, 2024

https://docs.astral.sh/ruff/rules/#pylint-pl
Image

This looks like using C, E, R or W should enable/disable Pylint rules, but this is wrong as the codes are actually PLC, PLE, PLR and PLW.

This is especially vicious given that W and E are existing pycodestyle groups https://docs.astral.sh/ruff/rules/#pycodestyle-e-w, so config validations will pass.

Even the URL currently needs to disambiguate between pycodestyle and pylint error/warning groups https://docs.astral.sh/ruff/rules/#error-e_1 and https://docs.astral.sh/ruff/rules/#warning-w_1 (notice the _1)

@dhruvmanila dhruvmanila added the documentation Improvements or additions to documentation label Dec 30, 2024
@MichaReiser
Copy link
Member

Using the full error code in parentheses does make sense to me

@MichaReiser MichaReiser added the help wanted Contributions especially welcome label Dec 30, 2024
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 help wanted Contributions especially welcome
Projects
None yet
Development

No branches or pull requests

3 participants