Skip to content

Commit

Permalink
Updated the headlines in the UnexpectedError documentation to be more…
Browse files Browse the repository at this point in the history
… descriptive
  • Loading branch information
sunesimonsen committed May 18, 2015
1 parent 2d1f5d2 commit e09ecb0
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 2 deletions.
4 changes: 2 additions & 2 deletions documentation/api/UnexpectedError.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,14 @@ When assertions fails in Unexpected they yield an
`UnexpectedError`. This instance has several convenience methods for
retrieving information about the error.

### getErrorMessage()
### unexpectedError.getErrorMessage()

Returns the error message as a
[magicpen](https://github.com/sunesimonsen/magicpen) instance. The
method uses the assertion error modes to produce the correct
error message.

### parent
### unexpectedError.parent

When assertions delegate to nested `expect` calls the errors that are
thrown on each level are chained together through the `parent`
Expand Down
1 change: 1 addition & 0 deletions test/documentation.spec.js
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ describe("documentation tests", function () {

});


it("api/addAssertion.md contains correct examples", function () {
var testPromises = [];
var errorMode = 'default'; // use to control the error mode later in the example
Expand Down

0 comments on commit e09ecb0

Please sign in to comment.