Update pre-commit documentation #8545
Merged
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
charliermarsh
force-pushed
the
charlie/pre-commit
branch
from
fa5898c to
cea3c8c
Compare
zanieb
approved these changes
Nov 7, 2023
charliermarsh
commented
Nov 7, 2023
docs/integrations.md
Outdated
| require reformatting. | ||
| Ruff's lint hook should be placed run _before_ Ruff's formatter hook, as well as _before_ Black, | ||
| isort, and other formatting tools, as Ruff's fix behavior can output code changes that require | ||
| reformatting. |
There was a problem hiding this comment.
@zanieb -- I'm a little nervous about this change, is there any scenario in which this would be wrong?
There was a problem hiding this comment.
Well.. if you're using format rules? Like E501 would have false positives if you ran it before Black.
There was a problem hiding this comment.
But wouldn't Black then cause file changes, which would require you to re-run pre-commit? Or are there modes where people run pre-commit with allowed changes?
There was a problem hiding this comment.
Ruff would fail first, Black wouldn't run.
charliermarsh
force-pushed
the
charlie/pre-commit
branch
from
cea3c8c to
3cf712b
Compare
|
#8567 adds auto-update of these versions |
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.
I got some feedback on Mastodon that it wasn't clear how to use the linter and formatter together in pre-commit (mostly in the pre-commit repo's documentation, which is even less clear, but the two should be consistent).