Skip to content

Commit c6c1067

Browse files
committed
Document using nbstripout on all files in the current directory and subdirectories recursively
This was requested in #127.
1 parent 5077ab4 commit c6c1067

File tree

1 file changed

+19
-12
lines changed

1 file changed

+19
-12
lines changed

README.md

+19-12
Original file line numberDiff line numberDiff line change
@@ -74,6 +74,25 @@ or
7474

7575
nbstripout -t FILE.ipynb | other-command
7676

77+
Do a dry run and only list which files would have been stripped:
78+
79+
nbstripout --dry-run FILE.ipynb [FILE2.ipynb ...]
80+
81+
Operate on all `.ipynb` files in the current directory and subdirectories
82+
recursively:
83+
84+
find . -name '*.ipynb' -exec nbstripout {} +
85+
86+
Print the version:
87+
88+
nbstripout --version
89+
90+
Show help and usage instructions:
91+
92+
nbstripout --help
93+
94+
### Using as a Git filter
95+
7796
Set up the git filter and attributes as described in the manual installation
7897
instructions below:
7998

@@ -132,18 +151,6 @@ if installed, 1 otherwise):
132151

133152
nbstripout --status
134153

135-
Do a dry run and only list which files would have been stripped:
136-
137-
nbstripout --dry-run FILE.ipynb [FILE2.ipynb ...]
138-
139-
Print the version:
140-
141-
nbstripout --version
142-
143-
Show help and usage instructions:
144-
145-
nbstripout --help
146-
147154
### Configuration files
148155

149156
The following table shows in which files the `nbstripout` filter and attribute

0 commit comments

Comments
 (0)