summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMatthew Sackman <matthew@rabbitmq.com>2011-02-25 12:25:16 +0000
committerMatthew Sackman <matthew@rabbitmq.com>2011-02-25 12:25:16 +0000
commit433f4df2880f7a36f636a2fd01b7efa884ec126f (patch)
tree0502b8baae87223bdbfc26f921e8389b0c1f9351
parent245592bc7051cfcb16cfd0dff84085d1294e8146 (diff)
downloadrabbitmq-server-git-433f4df2880f7a36f636a2fd01b7efa884ec126f.tar.gz
Make documentation accurate for current API...
-rw-r--r--src/gm.erl16
1 files changed, 8 insertions, 8 deletions
diff --git a/src/gm.erl b/src/gm.erl
index b3fb7eca53..b21217f673 100644
--- a/src/gm.erl
+++ b/src/gm.erl
@@ -55,14 +55,14 @@
%% start_link/3
%% Provide the group name, the callback module name, and any arguments
%% you wish to be passed into the callback module's functions. The
-%% joined/1 will be called when we have joined the group, and the list
-%% of arguments will have appended to it a list of the current members
-%% of the group. See the comments in behaviour_info/1 below for
-%% further details of the callback functions.
+%% joined/2 will be called when we have joined the group, with the
+%% arguments passed to start_link and a list of the current members of
+%% the group. See the comments in behaviour_info/1 below for further
+%% details of the callback functions.
%%
%% leave/1
%% Provide the Pid. Removes the Pid from the group. The callback
-%% terminate/1 function will be called.
+%% terminate/2 function will be called.
%%
%% broadcast/2
%% Provide the Pid and a Message. The message will be sent to all
@@ -455,16 +455,16 @@ behaviour_info(callbacks) ->
%% quickly, it's possible that we will never see that member
%% appear in either births or deaths. However we are guaranteed
%% that (1) we will see a member joining either in the births
- %% here, or in the members passed to joined/1 before receiving
+ %% here, or in the members passed to joined/2 before receiving
%% any messages from it; and (2) we will not see members die that
%% we have not seen born (or supplied in the members to
- %% joined/1).
+ %% joined/2).
{members_changed, 3},
%% Supplied with Args provided in start_link, the sender, and the
%% message. This does get called for messages injected by this
%% member, however, in such cases, there is no special
- %% significance of this call: it does not indicate that the
+ %% significance of this invocation: it does not indicate that the
%% message has made it to any other members, let alone all other
%% members.
{handle_msg, 3},