Skip to content

doc: improve documentation for the vm module - #16867

Closed
fhinkel wants to merge 1 commit into
nodejs:masterfrom
fhinkel:nov/explain-contextify
Closed

doc: improve documentation for the vm module#16867
fhinkel wants to merge 1 commit into
nodejs:masterfrom
fhinkel:nov/explain-contextify

Conversation

@fhinkel

Copy link
Copy Markdown
Member

I think an intro section would help the vm documentation.

Checklist
  • make lint (UNIX) passes
  • documentation is changed or added
  • commit message follows commit guidelines
Affected core subsystem(s)

doc

@nodejs-github-botnodejs-github-bot added doc Issues and PRs related to the documentations. vm Issues and PRs related to the vm subsystem. labels Nov 7, 2017
@fhinkel
fhinkelforce-pushed the nov/explain-contextify branch from 33b1644 to 73470c9CompareNovember 7, 2017 18:13
Comment threaddoc/api/vm.md Outdated

@benglbenglNov 7, 2017

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe:

The sandboxed code uses a different V8 Context, meaning...

Comment threaddoc/api/vm.md Outdated

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe "recorded on" -> "reflected in"

@fhinkel
fhinkelforce-pushed the nov/explain-contextify branch from 73470c9 to 3313580CompareNovember 7, 2017 20:48
Comment threaddoc/api/vm.md Outdated

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A nit: the it -> it

@fhinkel
fhinkelforce-pushed the nov/explain-contextify branch from 3313580 to ed0f7c8CompareNovember 8, 2017 06:14
Comment threaddoc/api/vm.md Outdated

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit: please avoid the use of informal pronouns like you in the docs :-)

Add an intro section and example for the vm module.
@fhinkel
fhinkelforce-pushed the nov/explain-contextify branch from ed0f7c8 to 76276f0CompareNovember 8, 2017 18:44
@fhinkel

Copy link
Copy Markdown
MemberAuthor

Thanks for the reviews. Landed in 5e1e460

@fhinkelfhinkel closed this Nov 9, 2017
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>
@evanlucasevanlucas mentioned this pull request Nov 13, 2017
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>
@MylesBorins

Copy link
Copy Markdown
Contributor

@fhinkel I've landed this on both v6.x and v8.x

please lmk if this isn't appropriate for those release lines

@gibfahngibfahn mentioned this pull request Nov 21, 2017
@MylesBorinsMylesBorins mentioned this pull request Nov 21, 2017
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 freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docIssues and PRs related to the documentations.vmIssues and PRs related to the vm subsystem.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

9 participants

@fhinkel@MylesBorins@bengl@jasnell@lpinca@cjihrig@gireeshpunathil@vsemozhetbyt@nodejs-github-bot