summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJeff Forcier <jeff@bitprophet.org>2015-02-06 15:33:28 -0800
committerJeff Forcier <jeff@bitprophet.org>2015-02-06 15:33:28 -0800
commitd97c938db32c44a8253f6f872cc3b354492a21cc (patch)
tree8d4d3611bf4d712c8e876a370f6dae8bf3150afa
parent9feab3ec9ef5bb0540faca4a0cb333b2757d8220 (diff)
downloadparamiko-d97c938db32c44a8253f6f872cc3b354492a21cc.tar.gz
Fix docstring for Sphinx
-rw-r--r--paramiko/client.py8
1 files changed, 3 insertions, 5 deletions
diff --git a/paramiko/client.py b/paramiko/client.py
index 312f71a9..dbe7fcba 100644
--- a/paramiko/client.py
+++ b/paramiko/client.py
@@ -177,11 +177,9 @@ class SSHClient (ClosingContextManager):
"""
Yield pairs of address families and addresses to try for connecting.
- @param hostname: the server to connect to
- @type hostname: str
- @param port: the server port to connect to
- @type port: int
- @rtype: generator
+ :param str hostname: the server to connect to
+ :param int port: the server port to connect to
+ :returns: Yields an iterable of ``(family, address)`` tuples
"""
guess = True
addrinfos = socket.getaddrinfo(hostname, port, socket.AF_UNSPEC, socket.SOCK_STREAM)