diff options
| author | James M Snell <jasnell@gmail.com> | 2018-02-05 21:55:16 -0800 |
|---|---|---|
| committer | Anatoli Papirovski <apapirovski@mac.com> | 2018-02-08 11:57:14 -0500 |
| commit | d3569b623ccd593c9ef62fcaf0aba2711dc7fbfa (patch) | |
| tree | 643d44f1eb33c9b822fea7742d2691355d295a4c /doc/api/vm.md | |
| parent | 809af1fe8a0a096be4f0a3020f8e60ee1c827cbc (diff) | |
| download | android-node-v8-d3569b623ccd593c9ef62fcaf0aba2711dc7fbfa.tar.gz android-node-v8-d3569b623ccd593c9ef62fcaf0aba2711dc7fbfa.tar.bz2 android-node-v8-d3569b623ccd593c9ef62fcaf0aba2711dc7fbfa.zip | |
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/vm.md')
| -rw-r--r-- | doc/api/vm.md | 18 |
1 files changed, 9 insertions, 9 deletions
diff --git a/doc/api/vm.md b/doc/api/vm.md index 8ea217da86..824cd4d403 100644 --- a/doc/api/vm.md +++ b/doc/api/vm.md @@ -40,8 +40,8 @@ console.log(sandbox.y); // 17 console.log(x); // 1; y is not defined. ``` -*Note*: The vm module is not a security mechanism. -**Do not use it to run untrusted code**. +**The vm module is not a security mechanism. Do not use it to run untrusted +code**. ## Class: vm.Module <!-- YAML @@ -68,7 +68,7 @@ Using a `vm.Module` object requires four distinct steps: creation/parsing, linking, instantiation, and evaluation. These four steps are illustrated in the following example. -*Note*: This implementation lies at a lower level than the [ECMAScript Module +This implementation lies at a lower level than the [ECMAScript Module loader][]. There is also currently no way to interact with the Loader, though support is planned. @@ -191,7 +191,7 @@ If the `module.status` is `'errored'`, this property contains the exception thro by the module during evaluation. If the status is anything else, accessing this property will result in a thrown exception. -*Note*: `undefined` cannot be used for cases where there is not a thrown +The value `undefined` cannot be used for cases where there is not a thrown exception due to possible ambiguity with `throw undefined;`. Corresponds to the [[EvaluationError]] field of [Source Text Module Record][]s @@ -465,9 +465,9 @@ console.log(util.inspect(sandbox)); // { animal: 'cat', count: 12, name: 'kitty' } ``` -*Note*: Using the `timeout` or `breakOnSigint` options will result in new -event loops and corresponding threads being started, which have a non-zero -performance overhead. +Using the `timeout` or `breakOnSigint` options will result in new event loops +and corresponding threads being started, which have a non-zero performance +overhead. ### script.runInNewContext([sandbox[, options]]) <!-- YAML @@ -803,8 +803,8 @@ const code = ` vm.runInThisContext(code)(require); ``` -*Note*: The `require()` in the above case shares the state with the context it -is passed from. This may introduce risks when untrusted code is executed, e.g. +The `require()` in the above case shares the state with the context it is +passed from. This may introduce risks when untrusted code is executed, e.g. altering objects in the context in unwanted ways. ## What does it mean to "contextify" an object? |