Skip to content

Commit 8efdb2b

Browse files
author
Dan
committed
Updated setup.py, docstrings
1 parent 1b03671 commit 8efdb2b

File tree

3 files changed

+3
-2
lines changed

3 files changed

+3
-2
lines changed

pssh/output.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ def __init__(self, host, cmd, channel, stdout, stderr, stdin,
3737
:param cmd: Command execution object
3838
:type cmd: :py:class:`gevent.Greenlet`
3939
:param channel: SSH channel used for command execution
40-
:type channel: :py:class:`paramiko.channel.Channel`
40+
:type channel: :py:class:`socket.socket` compatible object
4141
:param stdout: Standard output buffer
4242
:type stdout: generator
4343
:param stderr: Standard error buffer

pssh/pssh_client.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ def __init__(self, hosts, user=None, password=None, port=None, pkey=None,
8484
seconds, where (5 * (``num_retries``-1)) refers to a five (5) second
8585
delay between retries.
8686
:type timeout: int
87-
:param forward_ssh_agent: (Optional) Turn on SSH agent forwarding -
87+
:param forward_ssh_agent: (Optional) Turn on/off SSH agent forwarding -
8888
equivalent to `ssh -A` from the `ssh` command line utility.
8989
Defaults to ``True`` if not set.
9090
:type forward_ssh_agent: bool

setup.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@
2121
version=versioneer.get_version(),
2222
cmdclass=versioneer.get_cmdclass(),
2323
description='Asynchronous parallel SSH library',
24+
long_description=open('README.rst').read(),
2425
author='Panos Kittenis',
2526
author_email='22e889d8@opayq.com',
2627
url="https://github.com/pkittenis/parallel-ssh",

0 commit comments

Comments
 (0)