Skip to content

Commit

Permalink
update [local_]broadcast_from docs (#170)
Browse files Browse the repository at this point in the history
Presently, it is not clear that `broadcast_from` sends to all
but the sending process.  Update the docs to make it clear.
  • Loading branch information
simonmcconnell committed Nov 22, 2022
1 parent 8842933 commit 16e1327
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions lib/phoenix/pubsub.ex
Original file line number Diff line number Diff line change
Expand Up @@ -160,6 +160,9 @@ defmodule Phoenix.PubSub do
* `topic` - The topic to broadcast to, ie: `"users:123"`
* `message` - The payload of the broadcast
The default dispatcher will broadcast the message to all subscribers except for the
process that initiated the broadcast.
A custom dispatcher may also be given as a fifth, optional argument.
See the "Custom dispatching" section in the module documentation.
"""
Expand Down Expand Up @@ -197,6 +200,9 @@ defmodule Phoenix.PubSub do
* `topic` - The topic to broadcast to, ie: `"users:123"`
* `message` - The payload of the broadcast
The default dispatcher will broadcast the message to all subscribers except for the
process that initiated the broadcast.
A custom dispatcher may also be given as a fifth, optional argument.
See the "Custom dispatching" section in the module documentation.
"""
Expand Down

0 comments on commit 16e1327

Please sign in to comment.