doc: general improvements to vm.md copy #6827
Conversation
jasnell
added
doc
jasnell
changed the title
| @@ -4,7 +4,8 @@ | |||
|
|
|||
| <!--name=vm--> | |||
|
|
|||
| You can access this module with: | |||
| The `vm` module provides an API for compiling and running code within V8 | |||
There was a problem hiding this comment.
an API? It should have been APIs right?
There was a problem hiding this comment.
Either works but will switch it to the plural form, sounds better.
|
Thank you all for the quick review. I absolutely love it that I can open a draft like this and open my inbox in the morning and find comments on it already :-) |
|
Updated! PTAL |
|
|
||
| When using either `script.runInThisContext()` or `vm.runInThisContext()`, the | ||
| code is executed within the current V8 global context. The code passed | ||
| to this VM context will have it's own isolated scope. |
There was a problem hiding this comment.
grr... my dang muscle memory on typing that stupid ' every time I want to type its it's freaking annoying...
|
Suggestion: replace "any stack traces produced from this script" with "stack traced produced by this script", it's a little more succinct. LGTM (with grammar nit) either way, though. |
|
Updated to address the nits. Thank you for the review! |
General improvements to vm module documentation
General improvements to vm module documentation PR-URL: #6827 Reviewed-By: Ben Noordhuis <[email protected]>
|
Landed in baeed8b |
General improvements to vm module documentation PR-URL: #6827 Reviewed-By: Ben Noordhuis <[email protected]>
General improvements to vm module documentation PR-URL: #6827 Reviewed-By: Ben Noordhuis <[email protected]>
Checklist
Affected core subsystem(s)
doc (vm)
Description of change
General improvements to vm module documentation
/cc @nodejs/documentation @bnoordhuis