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

Add reasonings for rules in documentation #13

Open
LKajan opened this issue May 3, 2024 · 2 comments · May be fixed by #14
Open

Add reasonings for rules in documentation #13

LKajan opened this issue May 3, 2024 · 2 comments · May be fixed by #14
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@LKajan
Copy link
Contributor

LKajan commented May 3, 2024

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

@Joonalai
Copy link
Contributor

Joonalai commented May 3, 2024

Is it enough to improve the documentation in README.md?

@LKajan
Copy link
Contributor Author

LKajan commented May 3, 2024

That should be enough for now.

@Joonalai Joonalai linked a pull request May 13, 2024 that will close this issue
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 enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants