doc: improve documentation for the vm module #16867
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
nodejs-github-bot
added
doc
fhinkel
force-pushed
the
nov/explain-contextify
branch
from
33b1644
to
73470c9
Compare
bengl
reviewed
Nov 7, 2017
doc/api/vm.md
Outdated
| compiled, saved, and run later. | ||
|
|
||
| A common use case is to run the code in a sandboxed environment. | ||
| Then the sandboxed code uses a different |
There was a problem hiding this comment.
Maybe:
The sandboxed code uses a different V8 Context, meaning...
cjihrig
approved these changes
Nov 7, 2017
doc/api/vm.md
Outdated
| sandbox object. | ||
| The sandboxed code treats any property on the sandbox like a | ||
| global variable. Any changes on global variables caused by the sandboxed | ||
| code are recorded on the sandbox object. |
There was a problem hiding this comment.
Maybe "recorded on" -> "reflected in"
fhinkel
force-pushed
the
nov/explain-contextify
branch
from
73470c9
to
3313580
Compare
vsemozhetbyt
reviewed
Nov 8, 2017
doc/api/vm.md
Outdated
|
|
||
| A common use case is to run the code in a sandboxed environment. | ||
| Then the sandboxed code uses a different V8 Context, meaning that | ||
| the it has a different global object than the rest of the code. |
fhinkel
force-pushed
the
nov/explain-contextify
branch
from
3313580
to
ed0f7c8
Compare
jasnell
reviewed
Nov 8, 2017
doc/api/vm.md
Outdated
| The sandboxed code uses a different V8 Context, meaning that | ||
| it has a different global object than the rest of the code. | ||
|
|
||
| You can provide the context by ["contextifying"][contextified] a sandbox |
There was a problem hiding this comment.
Nit: please avoid the use of informal pronouns like you in the docs :-)
gireeshpunathil
approved these changes
Nov 8, 2017
lpinca
approved these changes
Nov 8, 2017
Add an intro section and example for the vm module.
fhinkel
force-pushed
the
nov/explain-contextify
branch
from
ed0f7c8
to
76276f0
Compare
|
Thanks for the reviews. Landed in 5e1e460 |
fhinkel
added a commit
that referenced
this pull request
Nov 9, 2017
Add an intro section and example for the vm module. PR-URL: #16867 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
evanlucas
pushed a commit
that referenced
this pull request
Nov 13, 2017
Add an intro section and example for the vm module. PR-URL: #16867 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Merged
MylesBorins
pushed a commit
that referenced
this pull request
Nov 17, 2017
Add an intro section and example for the vm module. PR-URL: #16867 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
MylesBorins
pushed a commit
that referenced
this pull request
Nov 17, 2017
Add an intro section and example for the vm module. PR-URL: #16867 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
|
@fhinkel I've landed this on both v6.x and v8.x please lmk if this isn't appropriate for those release lines |
Merged
Merged
MylesBorins
pushed a commit
that referenced
this pull request
Nov 21, 2017
Add an intro section and example for the vm module. PR-URL: #16867 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
MylesBorins
pushed a commit
that referenced
this pull request
Nov 28, 2017
Add an intro section and example for the vm module. PR-URL: #16867 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I think an intro section would help the vm documentation.
Checklist
make lint(UNIX) passesAffected core subsystem(s)
doc