diff options
author | Jeff Forcier <jeff@bitprophet.org> | 2014-02-24 17:06:08 -0800 |
---|---|---|
committer | Jeff Forcier <jeff@bitprophet.org> | 2014-02-24 17:06:08 -0800 |
commit | c8382442f51eda4ac47de5d3842d4923d0642e5d (patch) | |
tree | a33d05d8fb2a830e1370b96552b20c60635051ff | |
parent | 4fb748ccf8743099198daa00265bb38ea096044f (diff) |
Docstring cleanups
-rw-r--r-- | paramiko/agent.py | 21 |
1 files changed, 13 insertions, 8 deletions
diff --git a/paramiko/agent.py b/paramiko/agent.py index 13d90dbe..8571f31a 100644 --- a/paramiko/agent.py +++ b/paramiko/agent.py @@ -93,7 +93,9 @@ class AgentSSH(object): class AgentProxyThread(threading.Thread): - """ Class in charge of communication between two chan """ + """ + Class in charge of communication between two channels. + """ def __init__(self, agent): threading.Thread.__init__(self, target=self.run) self._agent = agent @@ -148,8 +150,10 @@ class AgentLocalProxy(AgentProxyThread): AgentProxyThread.__init__(self, agent) def get_connection(self): - """ Return a pair of socket object and string address - May Block ! + """ + Return a pair of socket object and string address. + + May block! """ conn = socket.socket(socket.AF_UNIX, socket.SOCK_STREAM) try: @@ -177,13 +181,14 @@ class AgentRemoteProxy(AgentProxyThread): class AgentClientProxy(object): """ Class proxying request as a client: - -> client ask for a request_forward_agent() - -> server creates a proxy and a fake SSH Agent - -> server ask for establishing a connection when needed, + + #. client ask for a request_forward_agent() + #. server creates a proxy and a fake SSH Agent + #. server ask for establishing a connection when needed, calling the forward_agent_handler at client side. - -> the forward_agent_handler launch a thread for connecting + #. the forward_agent_handler launch a thread for connecting the remote fake agent and the local agent - -> Communication occurs ... + #. Communication occurs ... """ def __init__(self, chanRemote): self._conn = None |