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

Documentation only Testament unittest (#16532)

Browse source 
* Link Testament from unittest doc

* Update lib/pure/unittest.nim

Co-authored-by: flywind <43030857+xflywind@users.noreply.github.com>

Co-authored-by: flywind <43030857+xflywind@users.noreply.github.com>
This commit is contained in:
Juan Carlos 2021-01-01 15:44:06 -03:00 • committed by GitHub
commit 505d04389a
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 13 additions and 9 deletions
Download patch file Download diff file Expand all files Collapse all files

22
lib/pure/unittest.nim
View file

@ -9,11 +9,6 @@
## :Author: Zahary Karadjov ## :Author: Zahary Karadjov
## ##
## **Note**: Instead of ``unittest.nim``, please consider to use
## the ``testament`` tool which offers process isolation for your tests.
## Also ``when isMainModule: doAssert conditionHere`` is usually a
## much simpler solution for testing purposes.
##
## This module implements boilerplate to make unit testing easy. ## This module implements boilerplate to make unit testing easy.
## ##
## The test status and name is printed after any output or traceback. ## The test status and name is printed after any output or traceback.
@ -22,9 +17,18 @@
## parent test as failed. Setup and teardown are inherited. Setup can be ## parent test as failed. Setup and teardown are inherited. Setup can be
## overridden locally. ## overridden locally.
## ##
## Compiled test files as well as ``nim c -r <testfile.nim>`` ## Compiled test files as well as `nim c -r <testfile.nim>`
## exit with 0 for success (no failed tests) or 1 for failure. ## exit with 0 for success (no failed tests) or 1 for failure.
## ##
## Testament
## =========
##
## Instead of `unittest`, please consider using
## `the Testament tool <testament.html>`_ which offers process isolation for your tests.
##
## Alternatively using `when isMainModule: doAssert conditionHere` is usually a
## much simpler solution for testing purposes.
##
## Running a single test ## Running a single test
## ===================== ## =====================
## ##
@ -39,7 +43,7 @@
## Running a single test suite ## Running a single test suite
## =========================== ## ===========================
## ##
## Specify the suite name delimited by ``"::"``. ## Specify the suite name delimited by `"::"`.
## ##
## .. code:: ## .. code::
## ##
@ -50,7 +54,7 @@
## ##
## A single ``"*"`` can be used for globbing. ## A single ``"*"`` can be used for globbing.
## ##
## Delimit the end of a suite name with ``"::"``. ## Delimit the end of a suite name with `"::"`.
## ##
## Tests matching **any** of the arguments are executed. ## Tests matching **any** of the arguments are executed.
## ##
@ -92,7 +96,7 @@
## discard v[4] ## discard v[4]
## ##
## echo "suite teardown: run once after the tests" ## echo "suite teardown: run once after the tests"
## ##
## Limitations/Bugs ## Limitations/Bugs
## ================ ## ================
## Since `check` will rewrite some expressions for supporting checkpoints ## Since `check` will rewrite some expressions for supporting checkpoints