doc: fix console.assert docs, message is a format
authorSam Roberts <sam@strongloop.com>
Sat, 5 Jul 2014 21:22:45 +0000 (14:22 -0700)
committerFedor Indutny <fedor@indutny.com>
Mon, 7 Jul 2014 05:44:40 +0000 (08:44 +0300)
Documentation for console.assert incorrectly described message as a
single message, but it is a format.

Signed-off-by: Fedor Indutny <fedor@indutny.com>
doc/api/console.markdown

index e53902f..e7807fe 100644 (file)
@@ -66,10 +66,10 @@ Finish timer, record output. Example:
 
 Print a stack trace to stderr of the current position.
 
-## console.assert(expression, [message])
+## console.assert(value, [message], [...])
 
-Same as [assert.ok()][] where if the `expression` evaluates as `false` throw an
-AssertionError with `message`.
+Similar to [assert.ok()][], but the error message is formatted as
+`util.format(message...)`.
 
 [assert.ok()]: assert.html#assert_assert_value_message_assert_ok_value_message
 [util.format()]: util.html#util_util_format_format