Skip to content

Commit

Permalink
Docs: Document 'todo' in log details object
Browse files Browse the repository at this point in the history
  • Loading branch information
Arkni authored and trentmwillis committed Apr 25, 2017
1 parent cfc1ebf commit 9177f61
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion docs/callbacks/QUnit.log.md
Expand Up @@ -17,7 +17,7 @@ The properties of the details argument are listed below as options.
|-----------|-------------|
| callback (function) | Callback to execute. Provides a single argument with the callback details object |

#### Callback details: `callback( details: { result, actual, expected, message, source, module, name, runtime } )`
#### Callback details: `callback( details: { result, actual, expected, message, source, module, name, runtime, todo } )`

| parameter | description |
|-----------|-------------|
Expand All @@ -29,6 +29,7 @@ The properties of the details argument are listed below as options.
| `module` (string) | The test module name of the assertion. If the assertion is not connected to any module, the property's value will be _undefined_. |
| `name` (string) | The test block name of the assertion. |
| `runtime` (number) | The time elapsed in milliseconds since the start of the containing [`QUnit.test()`](/QUnit/test), including setup. |
| `todo` (boolean) | Indicates whether or not this assertion was part of a todo test. |

### Examples

Expand Down

0 comments on commit 9177f61

Please sign in to comment.