-
Notifications
You must be signed in to change notification settings - Fork 1.1k
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
[readme.md] Automated link to pylint documentation using pre-commit #2546
[readme.md] Automated link to pylint documentation using pre-commit #2546
Conversation
Not everyone uses |
Thanks for getting involved :) Happy to incorporate this but it does likely need to be part of |
Any tip on how to make |
d36ade4
to
bed2ab1
Compare
Couple of notes:
I am afraid that this is not really a beginner friendly issue, if you're new to Rust, you'll probably have a better experience trying to do something from the issues labeled as |
For what it's worth: it's fine to rename the Pylint rules to match upstream for now. We do it for most of them, and that's the current intent for that rule set, so any that deviate are an error. We need to do a pass to rename all rules consistently anyway prior to making that a public API. In other words: as long as we aren't applying |
I'd rather avoid needlessly naming rules back and forth. Many of the pylint rules are implemented also by flake8 plugins so naming them after pylint is rather arbitrary. |
Maybe we can:
|
bed2ab1
to
1e38b68
Compare
Let's omit this for now. We now have the ability to write documentation inline (see: #1467 (comment)), so we'll bring these over as first-class documentation in Ruff itself (see: #2646). |
This permit to have a link to the pylint documentation explaining the message using a pre-commit hook. Result here: https://github.com/Pierre-Sassoulas/ruff/tree/automated-link-to-pylint-doc#pylint-pl