Skip to content

Commit

Permalink
Add note about argument quoting for pre-commit hook to README
Browse files Browse the repository at this point in the history
See discussion in #119.
  • Loading branch information
kynan committed Dec 14, 2024
1 parent 4439d61 commit f380f5d
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -453,6 +453,16 @@ to the `.pre-commit-config.yaml` in your repository:

Then run `pre-commit install` to activate the hook.

When passing parameters to the hook, be aware that arguments with spaces such as
`--extra-keys` need to be quoted as a whole:

repos:
- repo: https://github.com/kynan/nbstripout
rev: 0.8.1
hooks:
- id: nbstripout
args: ['--extra-keys="metadata.celltoolbar cell.metadata.heading_collapsed"']

> [!WARNING]
>
> In this mode, `nbstripout` is used as a git hook to strip any `.ipynb` files
Expand Down

0 comments on commit f380f5d

Please sign in to comment.