Skip to content

Commit

Permalink
clarify CI-based error detection
Browse files Browse the repository at this point in the history
  • Loading branch information
Moxinilian committed Apr 16, 2024
1 parent 1eedd6b commit 6b54e44
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion docs/book/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,4 +14,4 @@ This will open the book it in your default browser and set up a local mdbook ser

In order to include source code in the book, create an accompanying Python file for your section. Then, include sections of the Python file in the markdown using [mdbook partial file inclusion features](https://rust-lang.github.io/mdBook/format/mdbook.html#including-portions-of-a-file).

The Python file should be able to run on its own and must be tested by CI. Prefer importing from adjacent Python files instead of redefining when your section depends on previous sections' definitions.
The Python file should be able to run on its own and must be tested by CI (any Python file added to this directory will be ran by CI for errors). Prefer importing from adjacent Python files instead of redefining when your section depends on previous sections' definitions.

0 comments on commit 6b54e44

Please sign in to comment.