Skip to content

Commit

Permalink
doc: clarify assert.fail doc
Browse files Browse the repository at this point in the history
PR-URL: #4186
Reviewed-By: Michaël Zasso <mic.besace@gmail.com>
Reviewed-By: Roman Klauke <romaaan.git@gmail.com>
Reviewed-By: Minwoo Jung <jmwsoft@gmail.com>
  • Loading branch information
Trott authored and Myles Borins committed Jan 19, 2016
1 parent 6235fdf commit c35a409
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions doc/api/assert.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -62,8 +62,9 @@ Tests shallow, coercive equality with the equal comparison operator ( `==` ).

## assert.fail(actual, expected, message, operator)

Throws an exception that displays the values for `actual` and `expected`
separated by the provided operator.
Throws an `AssertionError`. If `message` is falsy, it displays the values for
`actual` and `expected` separated by the provided `operator`. Otherwise, it
displays `message` (and does not use `actual`, `expected`, and `operator`).

## assert.ifError(value)

Expand Down

0 comments on commit c35a409

Please sign in to comment.