adding usage info for pre-commit #724
Open
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
Codecov ReportAll modified and coverable lines are covered by tests ✅
❗ Your organization needs to install the Codecov GitHub app to enable full functionality. Additional details and impacted files@@ Coverage Diff @@
## main #724 +/- ##
=======================================
Coverage 97.83% 97.83%
=======================================
Files 1 1
Lines 2402 2402
=======================================
Hits 2350 2350
Misses 52 52 ☔ View full report in Codecov by Sentry. |
hhatto
reviewed
Jan 5, 2025
| @@ -401,6 +401,7 @@ To add autopep8 as a plugin, add this repo definition to your configuration: | |||
|
|
|||
| .. _`pre-commit`: https://pre-commit.com | |||
|
|
|||
| If you don't use a configuration file for autpep8, you'll want to include either ``args: [--in-place]`` or ``args: [--diff]``. | |||
There was a problem hiding this comment.
I think it would be better to rephrase this since the use of --in-place or --diff options should be recommended for pre-commit usage regardless of whether a configuration file is used or not. Here's my suggested text:
Suggested change
| If you don't use a configuration file for autpep8, you'll want to include either ``args: [--in-place]`` or ``args: [--diff]``. | |
| When using autopep8 with pre-commit, it is recommended to include either ``args: [--in-place]`` or ``args: [--diff]``. |
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.
No description provided.