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

Put flake8-logging next to the other flake8 plugins in registry #10587

Merged
merged 1 commit into from
Mar 25, 2024

Conversation

FFY00
Copy link
Contributor

@FFY00 FFY00 commented Mar 25, 2024

Summary

This is just a nitpicky improvement, but I thought it'd be a good opportunity to look at the ruff source.

The rules list in the documentation is generated using the registry order. Currently, flake8-logging is separated from the rest of the flake8 plugins. This patch puts it next to them.

https://docs.astral.sh/ruff/rules/

If it makes sense, we could alternatively just sort the linters in https://github.com/astral-sh/ruff/blob/main/crates/ruff_dev/src/generate_rules_table.rs.

Test Plan

The rules list in the documentation is generated using the registry
order. Currently, flake8-logging is separated from the rest of the
flake8 plugins. This patch puts it next to them.

Signed-off-by: Filipe Laíns <[email protected]>
Copy link
Member

@charliermarsh charliermarsh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you!

@charliermarsh charliermarsh added the documentation Improvements or additions to documentation label Mar 25, 2024
@charliermarsh
Copy link
Member

I think the sorting there is intentional (Flake8 stuff, followed by the more specific linters like the numpy rules, followed by the Ruff set), so this fix seems right.

@charliermarsh charliermarsh enabled auto-merge (squash) March 25, 2024 20:17
@charliermarsh charliermarsh merged commit 960e474 into astral-sh:main Mar 25, 2024
17 checks passed
Copy link
Contributor

ruff-ecosystem results

Linter (stable)

✅ ecosystem check detected no linter changes.

Linter (preview)

✅ ecosystem check detected no linter changes.

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