jyapayne/Nim
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

followup #17077: also use assert instead of doAssert for code-block rst blocks intended to be used as runnableExamples (#17122)

Browse source
This commit is contained in:
Timothee Cour 2021-02-21 07:44:32 -08:00 • committed by GitHub
commit 4f10dde64a
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 2 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

3
doc/contributing.rst
View file

@ -344,7 +344,8 @@ tests so they'll be enabled even with `--assertions:off`.
doAssert foo() # preferred doAssert foo() # preferred
.. _runnableExamples_use_assert: .. _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 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 `runnableExamples`, but `nim doc --doccmd:-d:danger main` would, and so would the
second example below: second example below: