Skip to content

Commit f380f5d

Browse files
committed
Add note about argument quoting for pre-commit hook to README
See discussion in #119.
1 parent 4439d61 commit f380f5d

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

README.md

+10
Original file line numberDiff line numberDiff line change
@@ -453,6 +453,16 @@ to the `.pre-commit-config.yaml` in your repository:
453453

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

456+
When passing parameters to the hook, be aware that arguments with spaces such as
457+
`--extra-keys` need to be quoted as a whole:
458+
459+
repos:
460+
- repo: https://github.com/kynan/nbstripout
461+
rev: 0.8.1
462+
hooks:
463+
- id: nbstripout
464+
args: ['--extra-keys="metadata.celltoolbar cell.metadata.heading_collapsed"']
465+
456466
> [!WARNING]
457467
>
458468
> In this mode, `nbstripout` is used as a git hook to strip any `.ipynb` files

0 commit comments

Comments
 (0)