Skip to content

Commit 0f66a26

Browse files
author
Dan
committed
Updated documentation
1 parent 10fe430 commit 0f66a26

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

pssh/pssh_client.py

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -249,6 +249,10 @@ def run_command(self, *args, **kwargs):
249249
Defaults to True. With stop_on_errors set to False, exceptions are instead \
250250
added to output of `run_command`. See example usage below.
251251
:type stop_on_errors: bool
252+
:param shell: (Optional) Override shell to use to run command with. \
253+
Defaults to logged in user's defined shell. Use the shell's command \
254+
syntax, eg `shell='bash -c'` or `shell='zsh -c'`.
255+
:type shell: str
252256
:param use_shell: (Optional) Run command with or without shell. Defaults \
253257
to True - use shell defined in user login to run command string
254258
:type use_shell: bool
@@ -332,7 +336,7 @@ def run_command(self, *args, **kwargs):
332336
>>> {'otherhost': {'exit_code': None}, <..>}
333337
334338
**Run multiple commands in parallel**
335-
339+
336340
This short example demonstrates running long running commands in
337341
parallel, how long it takes for all commands to start, blocking until
338342
they complete and how long it takes for all commands to complete.

0 commit comments

Comments
 (0)