We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
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
Expected behaviour I want it to be more clear what each rule does, why it exists and how to fix it. Just like Ruff does for each rule. see https://docs.astral.sh/ruff/rules/is-literal/#why-is-this-bad
Current behaviour We kind of have the what part and examples but are certainly missing the why.
Additional context Ruff has for each of its rules: What it does, Why is this bad?, Example, References
The text was updated successfully, but these errors were encountered:
Is it enough to improve the documentation in README.md?
Sorry, something went wrong.
That should be enough for now.
Successfully merging a pull request may close this issue.
Expected behaviour
I want it to be more clear what each rule does, why it exists and how to fix it.
Just like Ruff does for each rule. see https://docs.astral.sh/ruff/rules/is-literal/#why-is-this-bad
Current behaviour
We kind of have the what part and examples but are certainly missing the why.
Additional context
Ruff has for each of its rules: What it does, Why is this bad?, Example, References
The text was updated successfully, but these errors were encountered: