diff options
author | Denys Otrishko <shishugi@gmail.com> | 2018-10-26 19:27:40 +0300 |
---|---|---|
committer | George Adams <george.adams@uk.ibm.com> | 2018-10-29 21:24:08 +0000 |
commit | f90cf19fdd729cff6147b12be191effa6113712e (patch) | |
tree | 26f3c1706954788e68cfb490087d7a8810adb92a /doc/api | |
parent | d7b95f1fe45ea1d62b133ebe8f9c55094738d51d (diff) | |
download | android-node-v8-f90cf19fdd729cff6147b12be191effa6113712e.tar.gz android-node-v8-f90cf19fdd729cff6147b12be191effa6113712e.tar.bz2 android-node-v8-f90cf19fdd729cff6147b12be191effa6113712e.zip |
doc: remove notice of dashes in V8 options
Previously only V8 options supported both dashes in them (making them
equivalent), but now Node.js also supports both styles so the note can
be removed.
PR-URL: https://github.com/nodejs/node/pull/23903
Refs: https://github.com/nodejs/node/pull/18592
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: George Adams <george.adams@uk.ibm.com>
Diffstat (limited to 'doc/api')
-rw-r--r-- | doc/api/assert.md | 12 | ||||
-rw-r--r-- | doc/api/child_process.md | 4 | ||||
-rw-r--r-- | doc/api/crypto.md | 2 | ||||
-rw-r--r-- | doc/api/dgram.md | 2 | ||||
-rw-r--r-- | doc/api/domain.md | 2 | ||||
-rw-r--r-- | doc/api/path.md | 2 | ||||
-rw-r--r-- | doc/api/vm.md | 2 |
7 files changed, 13 insertions, 13 deletions
diff --git a/doc/api/assert.md b/doc/api/assert.md index be53199200..e8249b0f32 100644 --- a/doc/api/assert.md +++ b/doc/api/assert.md @@ -426,10 +426,10 @@ the function does not return a promise, `assert.doesNotReject()` will return a rejected `Promise` with an [`ERR_INVALID_RETURN_VALUE`][] error. In both cases the error handler is skipped. -Please note: Using `assert.doesNotReject()` is actually not useful because there -is little benefit by catching a rejection and then rejecting it again. Instead, -consider adding a comment next to the specific code path that should not reject -and keep error messages as expressive as possible. +Using `assert.doesNotReject()` is actually not useful because there is little +benefit in catching a rejection and then rejecting it again. Instead, consider +adding a comment next to the specific code path that should not reject and keep +error messages as expressive as possible. If specified, `error` can be a [`Class`][], [`RegExp`][] or a validation function. See [`assert.throws()`][] for more details. @@ -472,8 +472,8 @@ changes: Asserts that the function `fn` does not throw an error. -Please note: Using `assert.doesNotThrow()` is actually not useful because there -is no benefit by catching an error and then rethrowing it. Instead, consider +Using `assert.doesNotThrow()` is actually not useful because there +is no benefit in catching an error and then rethrowing it. Instead, consider adding a comment next to the specific code path that should not throw and keep error messages as expressive as possible. diff --git a/doc/api/child_process.md b/doc/api/child_process.md index ce4f9913bd..b2a6e443f9 100644 --- a/doc/api/child_process.md +++ b/doc/api/child_process.md @@ -1056,9 +1056,9 @@ child process may not actually terminate the process. See kill(2) for reference. -Also note: on Linux, child processes of child processes will not be terminated +On Linux, child processes of child processes will not be terminated when attempting to kill their parent. This is likely to happen when running a -new process in a shell or with use of the `shell` option of `ChildProcess`: +new process in a shell or with the use of the `shell` option of `ChildProcess`: ```js 'use strict'; diff --git a/doc/api/crypto.md b/doc/api/crypto.md index b627054620..c00fad6578 100644 --- a/doc/api/crypto.md +++ b/doc/api/crypto.md @@ -845,7 +845,7 @@ const crypto = require('crypto'); const alice = crypto.createECDH('secp256k1'); const bob = crypto.createECDH('secp256k1'); -// Note: This is a shortcut way to specify one of Alice's previous private +// This is a shortcut way of specifying one of Alice's previous private // keys. It would be unwise to use such a predictable private key in a real // application. alice.setPrivateKey( diff --git a/doc/api/dgram.md b/doc/api/dgram.md index 4e50d24d4c..e263627723 100644 --- a/doc/api/dgram.md +++ b/doc/api/dgram.md @@ -419,7 +419,7 @@ added: v8.6.0 * `multicastInterface` {string} -*Note: All references to scope in this section are referring to +*All references to scope in this section are referring to [IPv6 Zone Indices][], which are defined by [RFC 4007][]. In string form, an IP with a scope index is written as `'IP%scope'` where scope is an interface name or interface number.* diff --git a/doc/api/domain.md b/doc/api/domain.md index 3cd021f9d4..eec763600e 100644 --- a/doc/api/domain.md +++ b/doc/api/domain.md @@ -122,7 +122,7 @@ if (cluster.isMaster) { d.on('error', (er) => { console.error(`error ${er.stack}`); - // Note: We're in dangerous territory! + // We're in dangerous territory! // By definition, something unexpected occurred, // which we probably didn't want. // Anything can happen now! Be very careful! diff --git a/doc/api/path.md b/doc/api/path.md index c04bff0c47..a5cd310690 100644 --- a/doc/api/path.md +++ b/doc/api/path.md @@ -54,7 +54,7 @@ path.posix.basename('/tmp/myfile.html'); // Returns: 'myfile.html' ``` -*Note:* On Windows Node.js follows the concept of per-drive working directory. +On Windows Node.js follows the concept of per-drive working directory. This behavior can be observed when using a drive path without a backslash. For example, `path.resolve('c:\\')` can potentially return a different result than `path.resolve('c:')`. For more information, see diff --git a/doc/api/vm.md b/doc/api/vm.md index 842ae3b81a..c4b7e3f9b3 100644 --- a/doc/api/vm.md +++ b/doc/api/vm.md @@ -7,7 +7,7 @@ <!--name=vm--> The `vm` module provides APIs for compiling and running code within V8 Virtual -Machine contexts. **Note that the `vm` module is not a security mechanism. Do +Machine contexts. **The `vm` module is not a security mechanism. Do not use it to run untrusted code**. The term "sandbox" is used throughout these docs simply to refer to a separate context, and does not confer any security guarantees. |