docs: improve api documentation

clebert · Apr 2, 2017 · 0a456d6 · 0a456d6
1 parent d75d0eb
commit 0a456d6
Showing 1 changed file with 5 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -228,20 +228,24 @@ test('foo', async t => {
 
 Type definition: **`fail(message: string, cause: Error): void`**
 
+Example TAP output: `not ok 1 - bar (cause: baz)`
+
 Example usage:
 
 ```ts
 const {test} = require('cybernaut');
 
 test('foo', async t => {
-  t.fail('bar', new Error('baz')); // Throws a new error 'Error: bar (cause: baz)'
+  t.fail('bar', new Error('baz')); // Throws a new error
 });
 ```
 
 #### `pass`
 
 Type definition: **`pass(message: string): void`**
 
+Example TAP output: `ok 1 - bar`
+
 Example usage:
 
 ```ts