[tor-commits] [stem/master] Documentation and output string fixes

[atagar at torproject.org]

commit cfc745e95010b4c86a8d794c118bfafafee4d59d
Author: Sean Robinson <seankrobinson at gmail.com>
Date:   Fri Dec 21 09:17:23 2012 -0700

    Documentation and output string fixes
    
    Signed-off-by: Sean Robinson <seankrobinson at gmail.com>
---
 stem/control.py                         |   10 +++++-----
 stem/descriptor/extrainfo_descriptor.py |    2 +-
 stem/response/__init__.py               |    1 +
 test/mocking.py                         |    2 +-
 test/unit/response/control_message.py   |    4 ++--
 5 files changed, 10 insertions(+), 9 deletions(-)

diff --git a/stem/control.py b/stem/control.py
index 1e5250a..15b762e 100644
--- a/stem/control.py
+++ b/stem/control.py
@@ -1045,8 +1045,8 @@ class Controller(BaseController):
     
     There are three use cases for GETCONF:
     
-      1. a single value is provided (ex. **ControlPort**)
-      2. multiple values are provided for the option (ex. **ExitPolicy**)
+      1. a single value is provided (e.g. **ControlPort**)
+      2. multiple values are provided for the option (e.g. **ExitPolicy**)
       3. a set of options that weren't necessarily requested are returned (for
          instance querying **HiddenServiceOptions** gives **HiddenServiceDir**,
          **HiddenServicePort**, etc)
@@ -1061,8 +1061,8 @@ class Controller(BaseController):
     :param str,list params: configuration option(s) to be queried
     :param object default: value for the mappings if the configuration option
       is either undefined or the query fails
-    :param bool multiple: if **True** then the provided are lists with all of
-      the present values
+    :param bool multiple: if **True** then the values provided are lists with
+      all of the present values
     
     :returns:
       **dict** of the 'config key => value' mappings. The value is a...
@@ -1429,7 +1429,7 @@ class Controller(BaseController):
     :param list,str path: one or more relays to make a circuit through
     :param str purpose: "general" or "controller"
     
-    :returns: int of the circuit id of the newly created circuit
+    :returns: str of the circuit id of the newly created circuit
     """
     
     return self.extend_circuit(0, path, purpose)
diff --git a/stem/descriptor/extrainfo_descriptor.py b/stem/descriptor/extrainfo_descriptor.py
index d53f79b..8ad10e1 100644
--- a/stem/descriptor/extrainfo_descriptor.py
+++ b/stem/descriptor/extrainfo_descriptor.py
@@ -856,7 +856,7 @@ class BridgeExtraInfoDescriptor(ExtraInfoDescriptor):
         
         for entry in value.split(','):
           if not '=' in entry:
-            raise stem.ProtocolError("The bridge-ip-versions should be a comma separated       listing of '<protocol>=<count>' mappings: %s" % line)
+            raise stem.ProtocolError("The bridge-ip-versions should be a comma separated listing of '<protocol>=<count>' mappings: %s" % line)
           
           protocol, count = entry.split('=', 1)
           
diff --git a/stem/response/__init__.py b/stem/response/__init__.py
index 2e9296d..06c80ca 100644
--- a/stem/response/__init__.py
+++ b/stem/response/__init__.py
@@ -63,6 +63,7 @@ def convert(response_type, message, **kwargs):
     * **\*** GETINFO
     * **\*** GETCONF
     * **&** **^** MAPADDRESS
+    * EVENT
     * PROTOCOLINFO
     * AUTHCHALLENGE
     * SINGLELINE
diff --git a/test/mocking.py b/test/mocking.py
index 86acb2a..20ac76e 100644
--- a/test/mocking.py
+++ b/test/mocking.py
@@ -445,7 +445,7 @@ def get_message(content, reformat = True):
   :param str content: base content for the controller message
   :param str reformat: modifies content to be more accommodating to being parsed
   
-  :returns: stem.socket.ControlMessage instance
+  :returns: stem.response.ControlMessage instance
   """
   
   if reformat:
diff --git a/test/unit/response/control_message.py b/test/unit/response/control_message.py
index 9ebd4bc..51ad8f0 100644
--- a/test/unit/response/control_message.py
+++ b/test/unit/response/control_message.py
@@ -96,8 +96,8 @@ class TestControlMessage(unittest.TestCase):
   
   def test_no_crlf(self):
     """
-    Checks that we get a ProtocolError when we don't have both a carrage
-    returna and newline for line endings. This doesn't really check for
+    Checks that we get a ProtocolError when we don't have both a carriage
+    return and newline for line endings. This doesn't really check for
     newlines (since that's what readline would break on), but not the end of
     the world.
     """