Open LKajan opened 2 months ago
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
Is it enough to improve the documentation in README.md?
That should be enough for now.
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