diff --git a/README.md b/README.md index 08a3bcc..838b1ba 100644 --- a/README.md +++ b/README.md @@ -22,7 +22,7 @@ Add this to your `.pre-commit-config.yaml` ### Hooks available -- `autopep8-wrapper` - Runs autopep8 over python source. +- `autopep8-wrapper` - Runs autopep8 over python source. (You'll want `args: ['-i]` when using this hook, see `.pre-commit-config.yaml` for an example.) - `check-added-large-files` - Prevent giant files from being committed. - `check-docstring-first` - Checks a common error of defining a docstring after code. - `check-json` - Attempts to load all json files to verify syntax. diff --git a/hooks.yaml b/hooks.yaml index fb9cc82..9e48555 100644 --- a/hooks.yaml +++ b/hooks.yaml @@ -1,6 +1,6 @@ - id: autopep8-wrapper name: autopep8 wrapper - description: Runs autopep8 over python source. + description: "Runs autopep8 over python source. (You'll want args: [-i] when using this hook, see .pre-commit-config.yaml for an example.)" entry: autopep8-wrapper language: python files: \.py$