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.

Sign up for GitHub

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

Jump to bottom

docs(cluster): message event docs slightly wrong/confusing #7997

Closed
zbjornson opened this issue Aug 6, 2016 · 2 comments
Closed

docs(cluster): message event docs slightly wrong/confusing #7997

zbjornson opened this issue Aug 6, 2016 · 2 comments
Labels
cluster Issues and PRs related to the cluster subsystem. doc Issues and PRs related to the documentations.

Comments

@zbjornson
Copy link
Contributor

From Cluster > Event: 'message'

Emitted when any worker receives a message.

I think this should say "sends a message." See gist -- when a worker receives a message from the master (which is how I read the docs currently), this is not triggered in either the worker or the master. It is triggered in the master when a worker sends a message.

Happy to PR if I'm not misunderstanding this.
@mscdex mscdex added cluster Issues and PRs related to the cluster subsystem. doc Issues and PRs related to the documentations. labels Aug 6, 2016
@cjihrig
Copy link
Contributor

cjihrig commented Aug 8, 2016 •
edited
Loading

Why not:

Emitted when a message is received from any worker.

Or, even more explicit:

Emitted when the cluster master receives a message from any worker.

zbjornson added a commit to zbjornson/node that referenced this issue Aug 8, 2016
@zbjornson
doc: fix cluster message event docs
a75022a 
* cluster "message" is emitted when master, not worker, receives a message from a worker.

Fixes nodejs#7997.
@zbjornson zbjornson mentioned this issue Aug 8, 2016
Closed
2 tasks
@zbjornson
Copy link
Contributor Author

Aye, your second one is explicit and more accurate than "when a worker sends a message."

PR #8017

cjihrig pushed a commit that referenced this issue Aug 10, 2016
@zbjornson @cjihrig
doc: fix cluster message event docs
96d15e2 
Fixes: #7997
PR-URL: #8017
Reviewed-By: Colin Ihrig <[email protected]>
Reviewed-By: Brian White <[email protected]>
Reviewed-By: James M Snell <[email protected]>
MylesBorins pushed a commit that referenced this issue Sep 30, 2016
@zbjornson
doc: fix cluster message event docs
0f9d7fd 
Fixes: #7997
PR-URL: #8017
Reviewed-By: Colin Ihrig <[email protected]>
Reviewed-By: Brian White <[email protected]>
Reviewed-By: James M Snell <[email protected]>
rvagg pushed a commit that referenced this issue Oct 18, 2016
@zbjornson @rvagg
doc: fix cluster message event docs
c39357d 
Fixes: #7997
PR-URL: #8017
Reviewed-By: Colin Ihrig <[email protected]>
Reviewed-By: Brian White <[email protected]>
Reviewed-By: James M Snell <[email protected]>
MylesBorins pushed a commit that referenced this issue Oct 26, 2016
@zbjornson @MylesBorins
doc: fix cluster message event docs
f1e14e4 
Fixes: #7997
PR-URL: #8017
Reviewed-By: Colin Ihrig <[email protected]>
Reviewed-By: Brian White <[email protected]>
Reviewed-By: James M Snell <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
cluster Issues and PRs related to the cluster subsystem. doc Issues and PRs related to the documentations.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@mscdex @zbjornson @cjihrig