Skip to content

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

Closed
Closed
docs(cluster): message event docs slightly wrong/confusing#7997
Labels
clusterIssues and PRs related to the cluster subsystem.docIssues and PRs related to Node.js documentation.

Description

@zbjornson
zbjornson
opened on Aug 6, 2016

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.

Activity

  1. mscdex
    added
    clusterIssues and PRs related to the cluster subsystem.
    docIssues and PRs related to Node.js documentation.
    on Aug 6, 2016

  2. cjihrig commented on Aug 8, 2016

    @cjihrig
    cjihrig
    on Aug 8, 2016
    Contributor

    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.

  3. zbjornson
    added a commit that references this issue on Aug 8, 2016

    doc: fix cluster message event docs

    a75022a

  4. zbjornson commented on Aug 8, 2016

    @zbjornson
    zbjornson
    on Aug 8, 2016
    ContributorAuthor

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

    PR #8017

  5. cjihrig
    closed this as completedin e925b62on Aug 10, 2016
  6. cjihrig
    added a commit that references this issue on Aug 10, 2016

    doc: fix cluster message event docs

    96d15e2
  7. MylesBorins
    added a commit that references this issue on Sep 30, 2016

    doc: fix cluster message event docs

    0f9d7fd
  8. rvagg
    added a commit that references this issue on Oct 18, 2016

    doc: fix cluster message event docs

    c39357d
  9. MylesBorins
    added a commit that references this issue on Oct 26, 2016

    doc: fix cluster message event docs

    f1e14e4
  10. sjarmak
    added a commit that references this issue on Jul 27, 2026

    doc: fix cluster message event docs

    e925b62
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    clusterIssues and PRs related to the cluster subsystem.docIssues and PRs related to Node.js documentation.

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions