Updated documentation. Code cleanup

Author: Dan

pssh.py

@@ -216,9 +216,9 @@ class ParallelSSHClient(object):
     """Uses :mod:`pssh.SSHClient`, performs tasks over SSH on multiple hosts in \
     parallel.
 
-    Connections to hosts are established in parallel when an object of this class \
-    is created, therefor any connection and/or authentication failures will happen \
-    on creation and need to be caught."""
+    Connections to hosts are established in parallel when an object of this
+    class is created, therefor any connection and/or authentication exceptions \
+    will happen on creation and need to be caught."""
 
     def __init__(self, hosts,
                  user=None, password=None, port=None, pkey=None,
@@ -272,12 +272,12 @@ def __init__(self, hosts,
         >>> cmds = client.exec_command('ls -ltrh /tmp/aasdfasdf', sudo = True)
         >>> output = [client.get_stdout(cmd, return_buffers=True) for cmd in cmds]
         >>> print output
-        [{'myhost1': {'exit_code': 2},
+        [{'myhost1': {'exit_code': 2,
         	      'stdout' : <generator object <genexpr>,
-                      'stderr' : <generator object <genexpr>},
-         {'myhost2': {'exit_code': 2}
+                      'stderr' : <generator object <genexpr>,}},
+         {'myhost2': {'exit_code': 2,
          	      'stdout' : <generator object <genexpr>,
-                      'stderr' : <generator object <genexpr>},
+                      'stderr' : <generator object <genexpr>,}},
                       ]
         >>> for host_stdout in output:
             ... for line in host_stdout[host_output.keys()[0]]['stdout']:
@@ -361,7 +361,7 @@ def _exec_command(self, host, *args, **kwargs):
         return self.host_clients[host].exec_command(*args, **kwargs)
 
     def get_stdout(self, greenlet, return_buffers=False):
-        """Print stdout from greenlet and return exit code for host
+        """Get/print stdout from greenlet and return exit code for host
         
         :mod:`pssh.get_stdout` will close the open SSH channel but this does
         **not** close the established connection to the remote host, only the
@@ -371,8 +371,8 @@ def get_stdout(self, greenlet, return_buffers=False):
         connections.
 
         By default, stdout and stderr will be logged via the logger named \
-        `host_logger` unless return_buffers is set to True in which case \
-        both buffers are returned along with the exit status.
+        ``host_logger`` unless ``return_buffers`` is set to ``True`` in which case \
+        both buffers are instead returned along with the exit status.
 
         :param greenlet: Greenlet object containing an \
         SSH channel reference, hostname, stdout and stderr buffers
@@ -384,9 +384,9 @@ def get_stdout(self, greenlet, return_buffers=False):
 
         :rtype: Dictionary containing ``{host: {'exit_code': exit code}}`` entry \
         for example ``{'myhost1': {'exit_code': 0}}``
-        :rtype: With return_buffers=True: ``{'myhost1': {'exit_code': 0},
-        						 'stdout' : <iterable>,
-                                                         'stderr' : <iterable>}``
+        :rtype: With ``return_buffers=True``: ``{'myhost1': {'exit_code': 0,
+         						     'stdout' : <iterable>,
+                                                             'stderr' : <iterable>,}}``
         """
         channel, host, _stdout, _stderr = greenlet.get()
         stdout = (line.strip() for line in _stdout)

tests/test_pssh_client.py

@@ -57,17 +57,17 @@ def test_pssh_client_exec_command_get_buffers(self):
         stdout = list(output['127.0.0.1']['stdout'])
         stderr = list(output['127.0.0.1']['stderr'])
         self.assertEqual(expected_exit_code, exit_code,
-                         msg = "Got unexpected exit code - %s, expected %s" % (
-                exit_code,
-                expected_exit_code,))
+                         msg = "Got unexpected exit code - %s, expected %s" %
+                         (exit_code,
+                          expected_exit_code,))
         self.assertEqual(expected_stdout, stdout,
-                         msg = "Got unexpected stdout - %s, expected %s" % (
-                stdout,
-                expected_stdout,))
+                         msg = "Got unexpected stdout - %s, expected %s" % 
+                         (stdout,
+                          expected_stdout,))
         self.assertEqual(expected_stderr, stderr,
-                         msg = "Got unexpected stderr - %s, expected %s" % (
-                stderr,
-                expected_stderr,))
+                         msg = "Got unexpected stderr - %s, expected %s" % 
+                         (stderr,
+                          expected_stderr,))
         del client
         server.join()