doc: clarify assert.fail doc

PR-URL: #4186 Reviewed-By: Michaël Zasso <[email protected]> Reviewed-By: Roman Klauke <[email protected]> Reviewed-By: Minwoo Jung <[email protected]>
nodejs · Dec 10, 2015 · 70fb06a · 70fb06a
1 parent e3187cc
commit 70fb06a
Showing 1 changed file with 3 additions and 2 deletions.
diff --git a/doc/api/assert.markdown b/doc/api/assert.markdown
@@ -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)