diff options
| author | Alexey Orlenko <eaglexrlnk@gmail.com> | 2017-05-20 16:15:58 -0400 |
|---|---|---|
| committer | Refael Ackermann <refack@gmail.com> | 2017-05-25 18:49:41 -0400 |
| commit | 2af49b6c89dd4355ec0c1779fdb1fb12cf10e68d (patch) | |
| tree | d0ba4f62fff9db7d42b3f86c7358d9219b288698 /doc/api/console.md | |
| parent | b3d1e3d4c720729c8f14e413a285660547ee677a (diff) | |
| download | android-node-v8-2af49b6c89dd4355ec0c1779fdb1fb12cf10e68d.tar.gz android-node-v8-2af49b6c89dd4355ec0c1779fdb1fb12cf10e68d.tar.bz2 android-node-v8-2af49b6c89dd4355ec0c1779fdb1fb12cf10e68d.zip | |
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 <refack@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Daijiro Wachi <daijiro.wachi@gmail.com>
Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Sam Roberts <vieuxtech@gmail.com>
Diffstat (limited to 'doc/api/console.md')
| -rw-r--r-- | doc/api/console.md | 8 |
1 files changed, 4 insertions, 4 deletions
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]) <!-- YAML |