Skip to content

Conversation

@jasnell
Copy link
Member

Checklist
  • documentation is changed or added
  • the commit message follows commit guidelines
Affected core subsystem(s)

doc (vm)

Description of change

General improvements to vm module documentation

/cc @nodejs/documentation @bnoordhuis

@jasnelljasnell added doc Issues and PRs related to the documentations. vm Issues and PRs related to the vm subsystem. labels May 18, 2016
@jasnelljasnell changed the title doc: improve vm.md copydoc: general improvements to vm.md copyMay 18, 2016
doc/api/vm.md Outdated
Copy link
Contributor

Choose a reason for hiding this comment

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

an API? It should have been APIs right?

Copy link
MemberAuthor

Choose a reason for hiding this comment

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

Either works but will switch it to the plural form, sounds better.

@jasnell
Copy link
MemberAuthor

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 :-)

@jasnell
Copy link
MemberAuthor

Updated! PTAL

doc/api/vm.md Outdated
Copy link
Member

Choose a reason for hiding this comment

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

its

Copy link
MemberAuthor

Choose a reason for hiding this comment

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

grr... my dang muscle memory on typing that stupid ' every time I want to type its it's freaking annoying...

@bnoordhuis
Copy link
Member

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.

@jasnell
Copy link
MemberAuthor

Updated to address the nits. Thank you for the review!

General improvements to vm module documentation
jasnell added a commit that referenced this pull request May 20, 2016
General improvements to vm module documentation PR-URL: #6827 Reviewed-By: Ben Noordhuis <[email protected]>
@jasnell
Copy link
MemberAuthor

Landed in baeed8b

@jasnelljasnell closed this May 20, 2016
Fishrock123 pushed a commit that referenced this pull request May 23, 2016
General improvements to vm module documentation PR-URL: #6827 Reviewed-By: Ben Noordhuis <[email protected]>
rvagg pushed a commit that referenced this pull request Jun 2, 2016
General improvements to vm module documentation PR-URL: #6827 Reviewed-By: Ben Noordhuis <[email protected]>
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.

5 participants

@jasnell@bnoordhuis@thefourtheye@addaleax@MylesBorins