diff options
author | n5m <72841454+n5m@users.noreply.github.com> | 2020-11-09 11:20:55 +0000 |
---|---|---|
committer | GitHub <noreply@github.com> | 2020-11-09 12:20:55 +0100 |
commit | 3bff12b96612be4e47e20d880d3ba9e57e8bf713 (patch) | |
tree | d706753e710be081d6fdaf973a11779a9be51170 /doc/testament.rst | |
parent | 204435ad97d7de20316d75cd7299cfa807361427 (diff) | |
download | Nim-3bff12b96612be4e47e20d880d3ba9e57e8bf713.tar.gz |
improve Testament docs (#15881)
* fix mentions of recursive test discovery * document that {.fatal.} pragmas cannot be caught
Diffstat (limited to 'doc/testament.rst')
-rw-r--r-- | doc/testament.rst | 10 |
1 files changed, 6 insertions, 4 deletions
diff --git a/doc/testament.rst b/doc/testament.rst index 18501f4cd..09c248d1f 100644 --- a/doc/testament.rst +++ b/doc/testament.rst @@ -58,12 +58,12 @@ Running all tests from a directory $ testament pattern "tests/*.nim" -To recursively search for all tests in a directory, use +To search for tests deeper in a directory, use .. code:: - $ testament pattern "tests/**/*.nim" - + $ testament pattern "tests/**/*.nim" # one level deeper + $ testament pattern "tests/**/**/*.nim" # two levels deeper HTML Reports ============ @@ -89,7 +89,9 @@ Example "template" **to edit** and write a Testament unittest: # Options: # "compile": expect successful compilation # "run": expect successful compilation and execution - # "reject": expect failed compilation + # "reject": expect failed compilation. The "reject" action can catch + # {.error.} pragmas but not {.fatal.} pragmas because + # {.fatal.} pragmas guarantee that compilation will be aborted. action: "run" # The exit code that the test is expected to return. Typically, the default |