From e2f2a202791293f2152a382852885bfd5eaf87e4 Mon Sep 17 00:00:00 2001 From: Sam Roberts Date: Sat, 5 Jul 2014 14:22:45 -0700 Subject: [PATCH] doc: fix console.assert docs, message is a format Documentation for console.assert incorrectly described message as a single message, but it is a format. Signed-off-by: Fedor Indutny --- doc/api/console.markdown | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/doc/api/console.markdown b/doc/api/console.markdown index e53902f7ad9..e7807feeaf2 100644 --- a/doc/api/console.markdown +++ b/doc/api/console.markdown @@ -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