Skip to content

Commit ccfcf4f

Browse files
committed
Merge pull request #153 from davidtheclark/patch-1
Clarify comment documentation
2 parents 99f32f5 + e1a6dd0 commit ccfcf4f

File tree

1 file changed

+4
-5
lines changed

1 file changed

+4
-5
lines changed

readme.markdown

+4-5
Original file line numberDiff line numberDiff line change
@@ -217,6 +217,10 @@ Create a subtest with a new test handle `st` from `cb(st)` inside the current
217217
test `t`. `cb(st)` will only fire when `t` finishes. Additional tests queued up
218218
after `t` will not be run until all subtests finish.
219219

220+
## t.comment(message)
221+
222+
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.)
223+
220224
## var htest = test.createHarness()
221225

222226
Create a new test harness instance, which is a function like `test()`, but with
@@ -226,11 +230,6 @@ By default the TAP output goes to `console.log()`. You can pipe the output to
226230
someplace else if you `htest.createStream().pipe()` to a destination stream on
227231
the first tick.
228232

229-
230-
## test.comment(message)
231-
232-
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.)
233-
234233
## test.only(name, cb)
235234

236235
Like `test(name, cb)` except if you use `.only` this is the only test case

0 commit comments

Comments
 (0)