Skip to content

Commit b8e4ac0

Browse files
author
Dan
committed
Updated documentation
1 parent 8731379 commit b8e4ac0

File tree

1 file changed

+6
-4
lines changed

1 file changed

+6
-4
lines changed

pssh/pssh_client.py

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -158,12 +158,14 @@ def __init__(self, hosts,
158158
Either iterating over stdout/stderr or `client.join(output)` will cause exit
159159
codes to be available in output without explicitly calling `get_exit_codes`.
160160
161+
Use ``client.join(output)`` to block until all commands have finished
162+
and gather exit codes at same time.
163+
161164
`client.pool.join()` does not update output and will need a call to
162165
`get_exit_codes` as shown below.
163166
164167
``get_exit_codes`` is not a blocking function and will not wait for commands
165-
to finish. Use ``client.join(output)`` to block until all commands have
166-
finished.
168+
to finish.
167169
168170
``output`` parameter is modified in-place.
169171
@@ -172,7 +174,7 @@ def __init__(self, hosts,
172174
>>> ... print output[host]['exit_code']
173175
0
174176
0
175-
177+
176178
Print stdout serially per host as it becomes available.
177179
178180
>>> for host in output: for line in output[host]['stdout']: print line
@@ -326,7 +328,7 @@ def run_command(self, *args, **kwargs):
326328
327329
>>> client.hosts = ['otherhost']
328330
>>> print client.run_command('exit 0')
329-
>>> {'otherhost': {'exit_code':0}, <..>}
331+
>>> {'otherhost': {'exit_code': None}, <..>}
330332
331333
**Run multiple commands in parallel**
332334

0 commit comments

Comments
 (0)