Skip to content
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.

Sign up for GitHub

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

adding usage info for pre-commit #724

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

adding usage info for pre-commit #724

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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]``.
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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]``.


Testing
=======
Expand Down