diff options
author | Timothee Cour <timothee.cour2@gmail.com> | 2021-02-21 07:44:32 -0800 |
---|---|---|
committer | GitHub <noreply@github.com> | 2021-02-21 23:44:32 +0800 |
commit | 4f10dde64a504d982ef0e1d46e42f506a9a88a1b (patch) | |
tree | c3e3e67dc3e2ba1ffc063e8305fb3313a56cce34 | |
parent | 6b7a6f8c546b8ab98d9cfe89e6bcd066c9037701 (diff) | |
download | Nim-4f10dde64a504d982ef0e1d46e42f506a9a88a1b.tar.gz |
followup #17077: also use assert instead of doAssert for `code-block` rst blocks intended to be used as `runnableExamples` (#17122)
-rw-r--r-- | doc/contributing.rst | 3 |
1 files changed, 2 insertions, 1 deletions
diff --git a/doc/contributing.rst b/doc/contributing.rst index ac7657de7..e6301faae 100644 --- a/doc/contributing.rst +++ b/doc/contributing.rst @@ -344,7 +344,8 @@ tests so they'll be enabled even with `--assertions:off`. doAssert foo() # preferred .. _runnableExamples_use_assert: -An exception to the above rule is `runnableExamples`, which for brevity use `assert` +An exception to the above rule is `runnableExamples` and `code-block` rst blocks +intended to be used as `runnableExamples`, which for brevity use `assert` instead of `doAssert`. Note that `nim doc -d:danger main` won't pass `-d:danger` to the `runnableExamples`, but `nim doc --doccmd:-d:danger main` would, and so would the second example below: |