Mention the --diff flag for format --check#104
Merged
eifinger merged 1 commit intoastral-sh:mainfrom Mar 19, 2025
Merged
Conversation
eifinger
approved these changes
Mar 19, 2025
Collaborator
eifinger
left a comment
There was a problem hiding this comment.
Makes sense!
Thank you for the addition! 🚀
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Just like for the action run adding annotations, the CI is the place where you'd want extra information.
Especially information that tells you how to fix an issue, which is relevant when a contributor doesn't want to / can't run the tool locally (an edit through the GitHub UI could be more convenient, don't want to bother installing extra tools locally, they're having issues not picking up the right Ruff version when ran locally, etc.)
It's also easier to opt-out of copy-pasting this flag, than not knowing about it in the first place.
Hence I think this documentation change is a positive to help anyone integrate this action into their CI for check+formatting by looking at the readme.