Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/nodejs/node.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJames M Snell <jasnell@gmail.com>2018-02-06 08:55:16 +0300
committerAnatoli Papirovski <apapirovski@mac.com>2018-02-08 19:57:14 +0300
commitd3569b623ccd593c9ef62fcaf0aba2711dc7fbfa (patch)
tree643d44f1eb33c9b822fea7742d2691355d295a4c /doc/api/timers.md
parent809af1fe8a0a096be4f0a3020f8e60ee1c827cbc (diff)
doc: remove **Note:** tags
Remove the various **Note:** prefixes throughout the docs. PR-URL: https://github.com/nodejs/node/pull/18592 Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Daniel Bevenius <daniel.bevenius@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
Diffstat (limited to 'doc/api/timers.md')
-rw-r--r--doc/api/timers.md20
1 files changed, 9 insertions, 11 deletions
diff --git a/doc/api/timers.md b/doc/api/timers.md
index 13f2dea37d9..30c3200b1d7 100644
--- a/doc/api/timers.md
+++ b/doc/api/timers.md
@@ -32,9 +32,8 @@ When called, requests that the Node.js event loop *not* exit so long as the
`Immediate` is active. Calling `immediate.ref()` multiple times will have no
effect.
-*Note*: By default, all `Immediate` objects are "ref'd", making it normally
-unnecessary to call `immediate.ref()` unless `immediate.unref()` had been called
-previously.
+By default, all `Immediate` objects are "ref'd", making it normally unnecessary
+to call `immediate.ref()` unless `immediate.unref()` had been called previously.
Returns a reference to the `Immediate`.
@@ -70,9 +69,8 @@ added: v0.9.1
When called, requests that the Node.js event loop *not* exit so long as the
`Timeout` is active. Calling `timeout.ref()` multiple times will have no effect.
-*Note*: By default, all `Timeout` objects are "ref'd", making it normally
-unnecessary to call `timeout.ref()` unless `timeout.unref()` had been called
-previously.
+By default, all `Timeout` objects are "ref'd", making it normally unnecessary
+to call `timeout.ref()` unless `timeout.unref()` had been called previously.
Returns a reference to the `Timeout`.
@@ -86,8 +84,8 @@ to remain active. If there is no other activity keeping the event loop running,
the process may exit before the `Timeout` object's callback is invoked. Calling
`timeout.unref()` multiple times will have no effect.
-*Note*: Calling `timeout.unref()` creates an internal timer that will wake the
-Node.js event loop. Creating too many of these can adversely impact performance
+Calling `timeout.unref()` creates an internal timer that will wake the Node.js
+event loop. Creating too many of these can adversely impact performance
of the Node.js application.
Returns a reference to the `Timeout`.
@@ -119,7 +117,7 @@ next event loop iteration.
If `callback` is not a function, a [`TypeError`][] will be thrown.
-*Note*: This method has a custom variant for promises that is available using
+This method has a custom variant for promises that is available using
[`util.promisify()`][]:
```js
@@ -176,12 +174,12 @@ Node.js makes no guarantees about the exact timing of when callbacks will fire,
nor of their ordering. The callback will be called as close as possible to the
time specified.
-*Note*: When `delay` is larger than `2147483647` or less than `1`, the `delay`
+When `delay` is larger than `2147483647` or less than `1`, the `delay`
will be set to `1`.
If `callback` is not a function, a [`TypeError`][] will be thrown.
-*Note*: This method has a custom variant for promises that is available using
+This method has a custom variant for promises that is available using
[`util.promisify()`][]:
```js