Skip to content

Commit

Permalink
DOC: Instruct jupyter execute over notebook test script
Browse files Browse the repository at this point in the history
  • Loading branch information
drewejohnson committed Aug 11, 2023
1 parent 7db6d49 commit 58a32c6
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion docs/develop/checklist.rst
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ in the package. These are converted to be used in our main documentation, and se
as a handy way for new users to discover the features provided with ``serpentTools``.
In order to ensure that these are valid notebooks as changes are introduced, our :term:`CI`
converts these to python scripts and runs them using
`the test notebooks script <https://github.com/CORE-GATECH-GROUP/serpent-tools/blob/develop/scripts/travis/testNotebooks.sh>`_.
``jupyter execute``.
It is beneficial to run this script during major changes to the API, as well as correcting any
errors or deprecated/removed features.

Expand Down

0 comments on commit 58a32c6

Please sign in to comment.