Skip to content

Commit

Permalink
include optional exception when mentioning ScenarioResult
Browse files Browse the repository at this point in the history
Helps with #1245
  • Loading branch information
davidjgoss committed Nov 3, 2019
1 parent 08b2f05 commit e46b8c3
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion docs/support_files/api_reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ Defines a hook which is run after each scenario.
* `tags`: string tag expression used to apply this hook to only specific scenarios. See [cucumber-tag-expressions](https://docs.cucumber.io/tag-expressions/) for more information
* `timeout`: A hook-specific timeout, to override the default timeout.
* `fn`: A function, defined as follows:
* The first argument will be an object of the form `{sourceLocation: {line, uri}, result: {duration, status}, pickle}`
* The first argument will be an object of the form `{sourceLocation: {line, uri}, result: {duration, status, exception?}, pickle}`
* The pickle object comes from the [gherkin](https://github.com/cucumber/cucumber/tree/gherkin-v4.1.3/gherkin) library. See `testdata/good/*.pickles.ndjson` for examples of its structure.
* When using the asynchronous callback interface, have one final argument for the callback function.

Expand Down

0 comments on commit e46b8c3

Please sign in to comment.