Skip to content

doc: fix, unify, formalize, and amplify vm.md - #25422

Closed
vsemozhetbyt wants to merge 2 commits into
nodejs:masterfrom
vsemozhetbyt:doc-vm-formalize
Closed

doc: fix, unify, formalize, and amplify vm.md#25422
vsemozhetbyt wants to merge 2 commits into
nodejs:masterfrom
vsemozhetbyt:doc-vm-formalize

Conversation

@vsemozhetbyt

@vsemozhetbytvsemozhetbyt commented Jan 9, 2019

Copy link
Copy Markdown
Contributor
Checklist
  • make -j4 test (UNIX), or vcbuild test (Windows) passes
  • documentation is changed or added
  • commit message follows commit guidelines

vm module API heavily reuses common code, but the doc seems to be a bit out of date: some options are listed in wrong places, some options and history entries are missed.

Also, some fragments need to be formalized and unified.

@vsemozhetbyt
doc: fix, unify, formalize, and amplify vm.md
907b16c
`vm` module API heavily reuses common code, but the doc seems
to be a bit out of date: some options are listed in wrong places,
some options and history entries are missed.
Also some fragments need to be formalized and unified.
@nodejs-github-bot

nodejs-github-bot commented Jan 9, 2019

Copy link
Copy Markdown
Collaborator

@vsemozhetbyt build started: https://ci.nodejs.org/blue/organizations/jenkins/node-test-pull-request-lite-pipeline/detail/node-test-pull-request-lite-pipeline/2211/pipeline

@nodejs-github-botnodejs-github-bot added doc Issues and PRs related to the documentations. tools Issues and PRs related to the tools directory. labels Jan 9, 2019
@vsemozhetbyt

vsemozhetbyt commented Jan 9, 2019

Copy link
Copy Markdown
ContributorAuthor

cc @nodejs/documentation @nodejs/vm

@vsemozhetbytvsemozhetbyt added the vm Issues and PRs related to the vm subsystem. label Jan 9, 2019
@jdalton

jdalton commented Jan 10, 2019

Copy link
Copy Markdown
Member

Pulling in @guybedford from #25421 (comment). He mentioned the importModuleDynamically could be considered experimental. I don't see it documented as such and I've heard mixed messaging on it so I think we should clarify.

It also looks like importModuleDynamically doesn't work without --experimental-modules to enable experimental ESM support so that should probably be documented as well.

@vsemozhetbyt

This comment has been minimized.

Sign in to view
guybedford
guybedford reviewed Jan 10, 2019
View reviewed changes
Comment threaddoc/api/vm.md
* Returns: {Module Namespace Object|vm.SourceTextModule} Returning a
`vm.SourceTextModule` is recommended in order to take advantage of error
tracking, and to avoid issues with namespaces that contain `then`
function exports.

This comment was marked as resolved.

Sign in to view

@guybedfordguybedfordJan 10, 2019

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.

Sorry I copied the wrong one, this should apply to the whole vm.sourceTextModule section.

The note above should apply only for the vm.Script option.

@vsemozhetbytvsemozhetbytJan 10, 2019

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

Added in vm.Script() constructor and all concerned vm.runIn...() methods.

@vsemozhetbytvsemozhetbytJan 10, 2019•
edited
Loading

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

vm.sourceTextModule already has experimental note.

guybedford
guybedford reviewed Jan 10, 2019
View reviewed changes
Comment threaddoc/api/vm.md
* Returns: {Module Namespace Object|vm.SourceTextModule} Returning a
`vm.SourceTextModule` is recommended in order to take advantage of error
tracking, and to avoid issues with namespaces that contain `then`
function exports.

This comment was marked as resolved.

Sign in to view

@vsemozhetbyt

vsemozhetbyt commented Jan 10, 2019

Copy link
Copy Markdown
ContributorAuthor

The note is added to all concerned places in a new commit.

@vsemozhetbytvsemozhetbyt added the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Jan 11, 2019
@vsemozhetbyt

vsemozhetbyt commented Jan 11, 2019

Copy link
Copy Markdown
ContributorAuthor

CI-lite: https://ci.nodejs.org/job/node-test-pull-request-lite-pipeline/2238/

@vsemozhetbyt

vsemozhetbyt commented Jan 11, 2019

Copy link
Copy Markdown
ContributorAuthor

Landed in c69ea3b
Thank you for the reviews.

@vsemozhetbyt
vsemozhetbyt deleted the doc-vm-formalize branch January 11, 2019 20:27
vsemozhetbyt added a commit that referenced this pull request Jan 11, 2019
@vsemozhetbyt
doc: fix, unify, formalize, and amplify vm.md
c69ea3b
`vm` module API heavily reuses common code, but the doc seems
to be a bit out of date: some options are listed in wrong places,
some options and history entries are missed.
Also some fragments need to be formalized and unified.
PR-URL: #25422
Reviewed-By: Gus Caplan <me@gus.host>
Reviewed-By: Ujjwal Sharma <usharma1998@gmail.com>
addaleax pushed a commit that referenced this pull request Jan 14, 2019
@vsemozhetbyt@addaleax
doc: fix, unify, formalize, and amplify vm.md
3db7a9f
`vm` module API heavily reuses common code, but the doc seems
to be a bit out of date: some options are listed in wrong places,
some options and history entries are missed.
Also some fragments need to be formalized and unified.
PR-URL: #25422
Reviewed-By: Gus Caplan <me@gus.host>
Reviewed-By: Ujjwal Sharma <usharma1998@gmail.com>
@BridgeARBridgeAR mentioned this pull request Jan 16, 2019
Merged
BridgeAR pushed a commit to BridgeAR/node that referenced this pull request Jan 16, 2019
@vsemozhetbyt@BridgeAR
doc: fix, unify, formalize, and amplify vm.md
60428bd
`vm` module API heavily reuses common code, but the doc seems
to be a bit out of date: some options are listed in wrong places,
some options and history entries are missed.
Also some fragments need to be formalized and unified.
PR-URL: nodejs#25422
Reviewed-By: Gus Caplan <me@gus.host>
Reviewed-By: Ujjwal Sharma <usharma1998@gmail.com>
@MylesBorinsMylesBorins mentioned this pull request Jan 24, 2019
Merged
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@guybedfordguybedfordguybedford left review comments
+2 more reviewers
@devsnekdevsnekdevsnek approved these changes
@ryzokukenryzokukenryzokuken approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

author readyPRs that have at least one approval, no pending requests for changes, and a CI started.docIssues and PRs related to the documentations.toolsIssues and PRs related to the tools directory.vmIssues and PRs related to the vm subsystem.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

6 participants

@vsemozhetbyt@nodejs-github-bot@jdalton@guybedford@devsnek@ryzokuken