From: Paul Selkirk <pselkirk@isc.org>
Date: Mon, 10 Jun 2013 15:41:58 +0000 (-0400)
Subject: [2922] documentation nits
X-Git-Tag: bind10-1.2.0beta1-release~406^2~10
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=b9fefbedb20b98f3a8a39550a9a1183208eb10ea;p=thirdparty%2Fkea.git

[2922] documentation nits
---

diff --git a/src/bin/msgq/msgq.py.in b/src/bin/msgq/msgq.py.in
index 1685a5eee9..ba7ac6c924 100755
--- a/src/bin/msgq/msgq.py.in
+++ b/src/bin/msgq/msgq.py.in
@@ -206,7 +206,7 @@ class MsgQ:
         Thin wrapper around ccs's notify. Send a notification about change
         of some list that can be requested by the members command.
 
-        The event is either one of:
+        The event is one of:
         - connected (client connected to MsgQ)
         - disconected (client disconnected from MsgQ)
         - subscribed (client subscribed to a group)
@@ -214,12 +214,12 @@ class MsgQ:
 
         The params is dict containing:
         - client: The lname of the client in question.
-        - group (only the 3rd and 4th): The group the client subscribed
-          or unsubscribed from.
+        - group (for 'subscribed' and 'unsubscribed' events):
+          The group the client subscribed or unsubscribed from.
 
-        It is expected to happen after the event (so client subscribing for these
-        notifications gets a notification about itself, but not in the case
-        of unsubscribing).
+        The notification occurs after the event, so client a subscribing for
+        notifications will get a notification about its own subscription, but
+	will not get a notification when it unsubscribes.
         """
         # Due to the interaction between threads (and fear it might influence
         # sending stuff), we test this method in msgq_run_test, instead of
@@ -850,9 +850,7 @@ class MsgQ:
             return isc.config.create_answer(0)
 
     def command_handler(self, command, args):
-        """The command handler (run in a separate thread).
-           Not tested, currently effectively empty.
-        """
+        """The command handler (run in a separate thread)."""
         config_logger.debug(TRACE_DETAIL, MSGQ_COMMAND, command, args)
 
         with self.__lock: