Skip to content

Commit 545db26

Browse files
committed
doc: Explain opts in t.test
1 parent ba44de6 commit 545db26

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

readme.markdown

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -261,12 +261,14 @@ Assert that the function call `fn()` throws an exception. `expected`, if present
261261

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

264-
## t.test(name, cb)
264+
## t.test(name, [opts], cb)
265265

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

270+
You may pass the same options that [`test()`](#testname-opts-cb) accepts.
271+
270272
## t.comment(message)
271273

272274
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.)

0 commit comments

Comments
 (0)