From 2af49b6c89dd4355ec0c1779fdb1fb12cf10e68d Mon Sep 17 00:00:00 2001 From: Alexey Orlenko Date: Sat, 20 May 2017 16:15:58 -0400 Subject: doc: make the style of notes consistent Make the style of "Note:" paragraphs consistent and document the guidelines in `doc/STYLE_GUIDE.md`. PR-URL: https://github.com/nodejs/node/pull/13133 Fixes: https://github.com/nodejs/node/issues/13131 Reviewed-By: Refael Ackermann Reviewed-By: Luigi Pinca Reviewed-By: Daijiro Wachi Reviewed-By: Michael Dawson Reviewed-By: James M Snell Reviewed-By: Sam Roberts --- doc/api/console.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) (limited to 'doc/api/console.md') diff --git a/doc/api/console.md b/doc/api/console.md index ca4ff637d9..f0fce96549 100644 --- a/doc/api/console.md +++ b/doc/api/console.md @@ -121,8 +121,8 @@ console.assert(false, 'Whoops %s', 'didn\'t work'); // AssertionError: Whoops didn't work ``` -*Note: the `console.assert()` method is implemented differently in Node.js -than the `console.assert()` method [available in browsers][web-api-assert].* +*Note*: The `console.assert()` method is implemented differently in Node.js +than the `console.assert()` method [available in browsers][web-api-assert]. Specifically, in browsers, calling `console.assert()` with a falsy assertion will cause the `message` to be printed to the console without @@ -282,10 +282,10 @@ console.timeEnd('100-elements'); // prints 100-elements: 225.438ms ``` -*Note: As of Node.js v6.0.0, `console.timeEnd()` deletes the timer to avoid +*Note*: As of Node.js v6.0.0, `console.timeEnd()` deletes the timer to avoid leaking it. On older versions, the timer persisted. This allowed `console.timeEnd()` to be called multiple times for the same label. This -functionality was unintended and is no longer supported.* +functionality was unintended and is no longer supported. ### console.trace([message][, ...args])