Fix incorrect documentation for assert.fail()
authorBrian White <mscdex@gmail.com>
Tue, 24 May 2011 05:40:09 +0000 (22:40 -0700)
committerRyan Dahl <ry@tinyclouds.org>
Tue, 24 May 2011 17:44:14 +0000 (10:44 -0700)
Fixes #1100.

doc/api/assert.markdown

index a0607e2..abced9d 100644 (file)
@@ -5,7 +5,7 @@ access it with `require('assert')`.
 
 ### assert.fail(actual, expected, message, operator)
 
-Tests if `actual` is equal to `expected` using the operator provided.
+Throws an exception that displays the values for `actual` and `expected` separated by the provided operator.
 
 ### assert.ok(value, [message])