doc: improve worker_threads documentation #26110
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This adds a few examples and clarifications.
Trott
reviewed
Feb 14, 2019
lpinca
approved these changes
Feb 14, 2019
Trott
reviewed
Feb 14, 2019
| @@ -156,6 +209,9 @@ Disables further sending of messages on either side of the connection. | |||
| This method can be called when no further communication will happen over this | |||
| `MessagePort`. | |||
|
|
|||
| The [`'close'` event][] will be emitted on both `MessagePort` instances that | |||
There was a problem hiding this comment.
Might be I'm over-reacting to passive voice, but perhaps this?:
Both `MessagePort` instances that are part of the channel will emit a [`'close'` event][].There was a problem hiding this comment.
I have to admit that active voice sounds a bit weird to me when referring to events :)
Trott
approved these changes
Feb 14, 2019
Trott
added
the
author ready
antsmartian
approved these changes
Feb 15, 2019
jasnell
reviewed
Feb 15, 2019
| @@ -91,6 +120,16 @@ added: v10.5.0 | |||
| An arbitrary JavaScript value that contains a clone of the data passed | |||
There was a problem hiding this comment.
It might be good to include more of a description of what "clone" here means in general. I know there are a few bits and pieces of an explanation through the doc, but coalescing those into a single section with some information on what types of values cannot be cloned, would be good.
jasnell
approved these changes
Feb 15, 2019
Fishrock123
reviewed
Feb 15, 2019
| The `worker_threads` module enables the use of threads with message channels | ||
| between them. To access it: | ||
| The `worker_threads` module enables the use of threads that execute JS code | ||
| in parallel. To access it: |
There was a problem hiding this comment.
Maybe something more like "that allow parallel execution contexts for JS code"?
There was a problem hiding this comment.
@Fishrock123 I’m not sure … “execution context” sounds like a very generic thing?
|
Landed in 70a500f |
addaleax
added a commit
that referenced
this pull request
Feb 17, 2019
This adds a few examples and clarifications. PR-URL: #26110 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Anto Aravinth <anto.aravinth.cse@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
addaleax
added a commit
that referenced
this pull request
Feb 17, 2019
This adds a few examples and clarifications. PR-URL: #26110 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Anto Aravinth <anto.aravinth.cse@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Merged
rvagg
pushed a commit
that referenced
this pull request
Feb 28, 2019
This adds a few examples and clarifications. PR-URL: #26110 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Anto Aravinth <anto.aravinth.cse@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This adds a few examples and clarifications.
Checklist
make -j4 test(UNIX), orvcbuild test(Windows) passes