Skip to content

Commit

Permalink
Merge pull request #153 from davidtheclark/patch-1
Browse files Browse the repository at this point in the history
Clarify comment documentation
  • Loading branch information
Raynos committed May 9, 2015
2 parents 99f32f5 + e1a6dd0 commit ccfcf4f
Showing 1 changed file with 4 additions and 5 deletions.
9 changes: 4 additions & 5 deletions readme.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -217,6 +217,10 @@ 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.

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

## var htest = test.createHarness()

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


## test.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.)

## test.only(name, cb)

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

0 comments on commit ccfcf4f

Please sign in to comment.