Proposal for Code Linting and Formatting with Ruff #2032
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
The docs for this PR live here. All of your documentation changes will be reflected on that endpoint. |
Smartappli
reviewed
Jul 19, 2024
| "I", # isort | ||
| "N", # pep8-naming | ||
| "NPY", # numpy | ||
| "PIE", # flake8-pie |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Hi there !
From
CONTRIBUTING.md:I suggest using ruff's code linter (and new formatter), like in other huggingface's projects, such as transformers.
This PR contributes a (somewhat overkill) ruff config in
pyproject.toml.All ruff rules are documented here: https://docs.astral.sh/ruff/rules/
The current config finds 8047 errors, 1982 of them being fixable.
This PR is marked as a draft to initiate discussion and gather feedback before making further modifications to
pyproject.toml,CONTRIBUTING.md, pre-commits, or the CI. Your thoughts and suggestions are welcome.