Skip to content

Commit cdfb6ab

Browse files
committed
add a docstring
1 parent ff441e0 commit cdfb6ab

File tree

1 file changed

+12
-2
lines changed

1 file changed

+12
-2
lines changed

scripts/run_notebooks/runner.py

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,21 @@
1010
--------
1111
Run all notebooks in a directory with mock code:
1212
13-
$ python scripts/run_notebooks/runner.py --notebooks notebooks/ --mock
13+
.. code-block:: bash
14+
15+
python scripts/run_notebooks/runner.py --notebooks notebooks/ --mock
1416
1517
Run a single notebook without mocked code:
1618
17-
$ python scripts/run_notebooks/runner.py --notebooks notebooks/notebook.ipynb --no-mock
19+
.. code-block:: bash
20+
21+
python scripts/run_notebooks/runner.py --notebooks notebooks/notebook.ipynb --no-mock
22+
23+
Run all the notebook is two different directories with mocked code (default):
24+
25+
.. code-block:: bash
26+
27+
python scripts/run_notebooks/runner.py --notebooks notebooks/ notebooks2/
1828
1929
"""
2030

0 commit comments

Comments
 (0)