summaryrefslogtreecommitdiff
path: root/paramiko/agent.py
diff options
context:
space:
mode:
authorJeff Forcier <jeff@bitprophet.org>2014-02-26 11:06:20 -0800
committerJeff Forcier <jeff@bitprophet.org>2014-02-26 11:06:20 -0800
commit7df1ae9602e0b5425ccfd9a1351e059fbbdfce89 (patch)
treee3e9f33a0dd3585a0c925372acc4fae08c9ca6ca /paramiko/agent.py
parent33452b2e6c7f7c48d7bfa6fcf770b1d27d6af2d6 (diff)
downloadparamiko-7df1ae9602e0b5425ccfd9a1351e059fbbdfce89.tar.gz
Start cleaning up info field lists
Diffstat (limited to 'paramiko/agent.py')
-rw-r--r--paramiko/agent.py11
1 files changed, 6 insertions, 5 deletions
diff --git a/paramiko/agent.py b/paramiko/agent.py
index cdb4313d..d9f4b1bc 100644
--- a/paramiko/agent.py
+++ b/paramiko/agent.py
@@ -52,8 +52,9 @@ class AgentSSH(object):
no SSH agent was running (or it couldn't be contacted), an empty list
will be returned.
- :return: a list of keys available on the SSH agent
- :rtype: tuple of `.AgentKey`
+ :return:
+ a tuple of `.AgentKey` objects representing keys available on the
+ SSH agent
"""
return self._keys
@@ -235,7 +236,7 @@ class AgentClientProxy(object):
class AgentServerProxy(AgentSSH):
"""
- :param t: transport used for SSH Agent communication forwarding
+ :param .Transport t: Transport used for SSH Agent communication forwarding
:raises SSHException: mostly if we lost the agent
"""
@@ -273,8 +274,8 @@ class AgentServerProxy(AgentSSH):
"""
Helper for the environnement under unix
- :return: the SSH_AUTH_SOCK Environnement variables
- :rtype: dict
+ :return:
+ a dict containing the ``SSH_AUTH_SOCK`` environnement variables
"""
env = {}
env['SSH_AUTH_SOCK'] = self._get_filename()