Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: fix misleading language in vm docs #10708

Closed
wants to merge 1 commit into from

Conversation

aqrln
Copy link
Contributor

@aqrln aqrln commented Jan 9, 2017

As @mscdex noted, the note following the http.Server example in the vm documentation contains misleading language. This commit removes the incorrect reference to threads.

Fixes: #10697

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

doc

@nodejs-github-bot nodejs-github-bot added doc Issues and PRs related to the documentations. vm Issues and PRs related to the vm subsystem. lts-watch-v6.x labels Jan 9, 2017
altering objects from the calling thread's context in unwanted ways.
*Note*: The `require()` in the above case shares the state with the context it
is passed from. This may introduce risks when untrusted code is executed, e.g.
altering objects from the context in unwanted ways.
Copy link
Contributor

Choose a reason for hiding this comment

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

Perhaps s/from/in/ ?

Copy link
Contributor Author

@aqrln aqrln Jan 9, 2017

Choose a reason for hiding this comment

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

I didn't change this sentence (except the addition of an article), but I think the author meant that require had been passed from the other context. However, it would be nice to reword the whole sentence, since there are some other quirks; e.g., why "shares the state with the context" if it just shares the same context.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@mscdex ah, sorry, we are talking about different lines.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yes, "in" should be used here.

@aqrln
Copy link
Contributor Author

aqrln commented Jan 9, 2017

@mscdex I've pushed a new commit. What about the line I've confused one you were talking about with, I think it's pretty okay though not perfect and I don't see a better way to reword it now.

@mscdex
Copy link
Contributor

mscdex commented Jan 9, 2017

LGTM.

@aqrln The rest is fine I think for now.

The note following the http.Server example in the vm documentation
contains misleading language. This commit removes the incorrect
reference to threads.

Fixes: nodejs#10697
@aqrln
Copy link
Contributor Author

aqrln commented Jan 11, 2017

@jasnell @mscdex I've updated the commit message so that it includes the full URL in the 'Fixes:' field, not just issue number.

@mscdex
Copy link
Contributor

mscdex commented Jan 11, 2017

Landed in 8781e61. Thanks!

@mscdex mscdex closed this Jan 11, 2017
mscdex pushed a commit that referenced this pull request Jan 11, 2017
The note following the http.Server example in the vm documentation
contains misleading language. This commit removes the incorrect
reference to threads.

Fixes: #10697
PR-URL: #10708
Reviewed-By: Brian White <mscdex@mscdex.net>
Reviewed-By: James M Snell <jasnell@gmail.com>
italoacasas pushed a commit to italoacasas/node that referenced this pull request Jan 18, 2017
The note following the http.Server example in the vm documentation
contains misleading language. This commit removes the incorrect
reference to threads.

Fixes: nodejs#10697
PR-URL: nodejs#10708
Reviewed-By: Brian White <mscdex@mscdex.net>
Reviewed-By: James M Snell <jasnell@gmail.com>
italoacasas pushed a commit to italoacasas/node that referenced this pull request Jan 23, 2017
The note following the http.Server example in the vm documentation
contains misleading language. This commit removes the incorrect
reference to threads.

Fixes: nodejs#10697
PR-URL: nodejs#10708
Reviewed-By: Brian White <mscdex@mscdex.net>
Reviewed-By: James M Snell <jasnell@gmail.com>
italoacasas pushed a commit to italoacasas/node that referenced this pull request Jan 24, 2017
The note following the http.Server example in the vm documentation
contains misleading language. This commit removes the incorrect
reference to threads.

Fixes: nodejs#10697
PR-URL: nodejs#10708
Reviewed-By: Brian White <mscdex@mscdex.net>
Reviewed-By: James M Snell <jasnell@gmail.com>
italoacasas pushed a commit to italoacasas/node that referenced this pull request Jan 27, 2017
The note following the http.Server example in the vm documentation
contains misleading language. This commit removes the incorrect
reference to threads.

Fixes: nodejs#10697
PR-URL: nodejs#10708
Reviewed-By: Brian White <mscdex@mscdex.net>
Reviewed-By: James M Snell <jasnell@gmail.com>
@italoacasas italoacasas mentioned this pull request Jan 29, 2017
MylesBorins pushed a commit that referenced this pull request Mar 7, 2017
The note following the http.Server example in the vm documentation
contains misleading language. This commit removes the incorrect
reference to threads.

Fixes: #10697
PR-URL: #10708
Reviewed-By: Brian White <mscdex@mscdex.net>
Reviewed-By: James M Snell <jasnell@gmail.com>
MylesBorins pushed a commit that referenced this pull request Mar 9, 2017
The note following the http.Server example in the vm documentation
contains misleading language. This commit removes the incorrect
reference to threads.

Fixes: #10697
PR-URL: #10708
Reviewed-By: Brian White <mscdex@mscdex.net>
Reviewed-By: James M Snell <jasnell@gmail.com>
@MylesBorins MylesBorins mentioned this pull request Mar 9, 2017
@aqrln aqrln deleted the vm-doc-context branch March 10, 2017 04:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Issues and PRs related to the documentations. vm Issues and PRs related to the vm subsystem.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants