Skip to content

Commit 2dcf0a1

Browse files
authored
Fix argument name in doc blocks (#191)
1 parent 4ffeb79 commit 2dcf0a1

File tree

1 file changed

+6
-5
lines changed

1 file changed

+6
-5
lines changed

lib/phoenix/tracker.ex

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -134,7 +134,7 @@ defmodule Phoenix.Tracker do
134134
@doc """
135135
Tracks a presence.
136136
137-
* `server_name` - The registered name of the tracker server
137+
* `tracker_name` - The registered name of the tracker server
138138
* `pid` - The Pid to track
139139
* `topic` - The `Phoenix.PubSub` topic for this presence
140140
* `key` - The key identifying this presence
@@ -161,7 +161,7 @@ defmodule Phoenix.Tracker do
161161
@doc """
162162
Untracks a presence.
163163
164-
* `server_name` - The registered name of the tracker server
164+
* `tracker_name` - The registered name of the tracker server
165165
* `pid` - The Pid to untrack
166166
* `topic` - The `Phoenix.PubSub` topic to untrack for this presence
167167
* `key` - The key identifying this presence
@@ -182,6 +182,7 @@ defmodule Phoenix.Tracker do
182182
|> Shard.name_for_topic(topic, pool_size(tracker_name))
183183
|> GenServer.call({:untrack, pid, topic, key})
184184
end
185+
185186
def untrack(tracker_name, pid) when is_pid(pid) do
186187
shard_multicall(tracker_name, {:untrack, pid})
187188
:ok
@@ -190,7 +191,7 @@ defmodule Phoenix.Tracker do
190191
@doc """
191192
Updates a presence's metadata.
192193
193-
* `server_name` - The registered name of the tracker server
194+
* `tracker_name` - The registered name of the tracker server
194195
* `pid` - The Pid being tracked
195196
* `topic` - The `Phoenix.PubSub` topic to update for this presence
196197
* `key` - The key identifying this presence
@@ -216,7 +217,7 @@ defmodule Phoenix.Tracker do
216217
@doc """
217218
Lists all presences tracked under a given topic.
218219
219-
* `server_name` - The registered name of the tracker server
220+
* `tracker_name` - The registered name of the tracker server
220221
* `topic` - The `Phoenix.PubSub` topic
221222
222223
Returns a list of presences in key/metadata tuple pairs.
@@ -236,7 +237,7 @@ defmodule Phoenix.Tracker do
236237
@doc """
237238
Gets presences tracked under a given topic and key pair.
238239
239-
* `server_name` - The registered name of the tracker server
240+
* `tracker_name` - The registered name of the tracker server
240241
* `topic` - The `Phoenix.PubSub` topic
241242
* `key` - The key of the presence
242243

0 commit comments

Comments
 (0)