From 9ae46dcbfaab42b450db410eecd8e7e94183f1b8 Mon Sep 17 00:00:00 2001
From: Jeff Forcier <jeff@bitprophet.org>
Date: Mon, 24 Feb 2014 17:00:53 -0800
Subject: [PATCH] Fix up AgentSSH vs Agent classes/docstrings, sigh

---
 paramiko/agent.py        | 29 +++++++----------------------
 sites/docs/api/agent.rst |  2 ++
 2 files changed, 9 insertions(+), 22 deletions(-)

diff --git a/paramiko/agent.py b/paramiko/agent.py
index f5b116c..302d31e 100644
--- a/paramiko/agent.py
+++ b/paramiko/agent.py
@@ -17,7 +17,7 @@
 # 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA.
 
 """
-SSH Agent interface for Unix clients.
+SSH Agent interface
 """
 
 import os
@@ -42,16 +42,6 @@ SSH2_AGENTC_REQUEST_IDENTITIES, SSH2_AGENT_IDENTITIES_ANSWER, \
 
 
 class AgentSSH(object):
-    """
-    Client interface for using private keys from an SSH agent running on the
-    local machine.  If an SSH agent is running, this class can be used to
-    connect to it and retreive `.PKey` objects which can be used when
-    attempting to authenticate to remote SSH servers.
-
-    Because the SSH agent protocol uses environment variables and unix-domain
-    sockets, this probably doesn't work on Windows.  It does work on most
-    posix platforms though (Linux and MacOS X, for example).
-    """
     def __init__(self):
         self._conn = None
         self._keys = ()
@@ -318,19 +308,14 @@ class Agent(AgentSSH):
     connect to it and retreive `.PKey` objects which can be used when
     attempting to authenticate to remote SSH servers.
 
-    Because the SSH agent protocol uses environment variables and unix-domain
-    sockets, this probably doesn't work on Windows.  It does work on most
-    posix platforms though (Linux and MacOS X, for example).
+    Upon initialization, a session with the local machine's SSH agent is
+    opened, if one is running. If no agent is running, initialization will
+    succeed, but `get_keys` will return an empty tuple.
+
+    :raises SSHException:
+        if an SSH agent is found, but speaks an incompatible protocol
     """
     def __init__(self):
-        """
-        Open a session with the local machine's SSH agent, if one is running.
-        If no agent is running, initialization will succeed, but `get_keys`
-        will return an empty tuple.
-
-        :raises SSHException: if an SSH agent is found, but speaks an
-            incompatible protocol
-        """
         AgentSSH.__init__(self)
 
         if ('SSH_AUTH_SOCK' in os.environ) and (sys.platform != 'win32'):
diff --git a/sites/docs/api/agent.rst b/sites/docs/api/agent.rst
index 789f7b1..3b614a8 100644
--- a/sites/docs/api/agent.rst
+++ b/sites/docs/api/agent.rst
@@ -2,3 +2,5 @@ SSH Agents
 ==========
 
 .. automodule:: paramiko.agent
+    :inherited-members:
+    :no-special-members: