Skip to content

Commit

Permalink
doc: Explain opts in t.test
Browse files Browse the repository at this point in the history
  • Loading branch information
ronkorving committed Feb 14, 2016
1 parent ba44de6 commit 545db26
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion readme.markdown
Expand Up @@ -261,12 +261,14 @@ Assert that the function call `fn()` throws an exception. `expected`, if present

Assert that the function call `fn()` does not throw an exception.

## t.test(name, cb)
## t.test(name, [opts], cb)

Create a subtest with a new test handle `st` from `cb(st)` inside the current
test `t`. `cb(st)` will only fire when `t` finishes. Additional tests queued up
after `t` will not be run until all subtests finish.

You may pass the same options that [`test()`](#testname-opts-cb) accepts.

## t.comment(message)

Print a message without breaking the tap output. (Useful when using e.g. `tap-colorize` where output is buffered & `console.log` will print in incorrect order vis-a-vis tap output.)
Expand Down

0 comments on commit 545db26

Please sign in to comment.