Updated travis yaml. Updated documentation

Author: pkittenis

.travis.yml

@@ -3,7 +3,7 @@ python:
   - "2.6"
   - "2.7"
 install:
-  - pip install -r requirements.txt --use-mirrors
+  - pip install -r requirements.txt
 script: nosetests
 notifications:
   email:

doc/conf.py

@@ -56,9 +56,9 @@
 # built documents.
 #
 # The short X.Y version.
-version = '0.3'
+version = '0.4'
 # The full version, including alpha/beta/rc tags.
-release = '0.3'
+release = '0.4'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

pssh.py

@@ -70,9 +70,9 @@ def __init__(self, host,
         :type port: int
         :param pkey: (Optional) Client's private key to be used to connect with
         :type pkey: :mod:`paramiko.PKey`
-        :raises: AuthenticationException on authentication error
-        :raises: UnknownHostException on DNS resolution error
-        :raises: ConnectionErrorException on error connecting"""
+        :raises: :mod:`pssh.AuthenticationException` on authentication error
+        :raises: :mod:`pssh.UnknownHostException` on DNS resolution error
+        :raises: :mod:`pssh.ConnectionErrorException` on error connecting"""
         ssh_config = paramiko.SSHConfig()
         _ssh_config_file = os.path.sep.join([os.path.expanduser('~'),
                                              '.ssh',
@@ -213,7 +213,11 @@ def copy_file(self, local_file, remote_file):
 
 class ParallelSSHClient(object):
     """Uses :mod:`pssh.SSHClient`, performs tasks over SSH on multiple hosts in \
-    parallel"""
+    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."""
 
     def __init__(self, hosts,
                  user=None, password=None, port=None, pkey=None,
@@ -237,9 +241,9 @@ def __init__(self, hosts,
         :param pool_size: (Optional) Greenlet pool size. Controls on how many\
         hosts to execute tasks in parallel. Defaults to 10
         :type pool_size: int
-        :raises: AuthenticationException on authentication error
-        :raises: UnknownHostException on DNS resolution error
-        :raises: ConnectionErrorException on error connecting
+        :raises: :mod:`pssh.AuthenticationException` on authentication error
+        :raises: :mod:`pssh.UnknownHostException` on DNS resolution error
+        :raises: :mod:`pssh.ConnectionErrorException` on error connecting
         
         **Example**
 
@@ -333,19 +337,20 @@ def _exec_command(self, host, *args, **kwargs):
 
     def get_stdout(self, greenlet):
         """Print stdout from greenlet and return exit code for host
-        :param greenlet: Greenlet object containing an \
-        SSH channel reference, hostname, stdout and stderr buffers
-        :type greenlet: :mod:`gevent.Greenlet`
-
-        :mod:`pssh.get_stdout` will close the open SSH channel but this does **not**
-        close the established connection to the remote host, only the
+        
+        :mod:`pssh.get_stdout` will close the open SSH channel but this does
+        **not** close the established connection to the remote host, only the
         authenticated SSH channel within it. This is standard practise
         in SSH when a command has finished executing. A new command
         will open a new channel which is very fast on already established
         connections.
 
-        :rtype: Dictionary containing {host: {'exit_code': exit code}} entry \
-        for example {'myhost1': {'exit_code': 0}}
+        :param greenlet: Greenlet object containing an \
+        SSH channel reference, hostname, stdout and stderr buffers
+        :type greenlet: :mod:`gevent.Greenlet`
+
+        :rtype: Dictionary containing ``{host: {'exit_code': exit code}}`` entry \
+        for example ``{'myhost1': {'exit_code': 0}}``
         """
         channel, host, stdout, stderr = greenlet.get()
         for line in stdout: