Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Sign up
Appearance settings

Commit 5cea5c1

Browse files
Updated docstrings, documentation (#343)
1 parent f9cc5ea commit 5cea5c1

File tree

3 files changed

+9
-9
lines changed

3 files changed

+9
-9
lines changed

‎doc/advanced.rst‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -396,7 +396,7 @@ This expands to the following per host commands:
396396
397397
A list of dictionaries can also be used as ``host_args`` for named argument substitution.
398398

399-
In the following example, first host in host list will use cmd ``echo command-1``, second host ``echo command-2`` and so on.
399+
In the following example, first host in host list will use cmd ``echo command-0``, second host ``echo command-1`` and so on.
400400

401401
.. code-block:: python
402402
@@ -546,7 +546,7 @@ SFTP and SCP are both supported by ``parallel-ssh`` and functions are provided b
546546

547547
Neither SFTP nor SCP have a shell interface and no output is sent for any SFTP/SCP commands.
548548

549-
As such, SFTP functions in ``ParallelSSHClient`` return greenlets that will need to be joined to raise any exceptions from them. :py:func:`gevent.joinall` may be used for that.
549+
As such, SFTP/SCP functions in ``ParallelSSHClient`` return greenlets that will need to be joined to raise any exceptions from them. :py:func:`gevent.joinall` may be used for that.
550550

551551

552552
Copying files to remote hosts in parallel

‎pssh/clients/native/parallel.py‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -282,7 +282,7 @@ def copy_file(self, local_file, remote_file, recurse=False, copy_args=None):
282282
local_file and recurse is not set
283283
:raises: :py:class:`pssh.exceptions.HostArgumentError` on number of
284284
per-host copy arguments not equal to number of hosts
285-
:raises: :py:class:`pss.exceptions.SFTPError` on SFTP initialisation
285+
:raises: :py:class:`pssh.exceptions.SFTPError` on SFTP initialisation
286286
errors
287287
:raises: :py:class:`pssh.exceptions.SFTPIOError` on I/O errors writing
288288
via SFTP
@@ -349,7 +349,7 @@ def copy_remote_file(self, remote_file, local_file, recurse=False,
349349
local_file and recurse is not set
350350
:raises: :py:class:`pssh.exceptions.HostArgumentError` on number of
351351
per-host copy arguments not equal to number of hosts
352-
:raises: :py:class:`pss.exceptions.SFTPError` on SFTP initialisation
352+
:raises: :py:class:`pssh.exceptions.SFTPError` on SFTP initialisation
353353
errors
354354
:raises: :py:class:`pssh.exceptions.SFTPIOError` on I/O errors reading
355355
from SFTP
@@ -410,7 +410,7 @@ def scp_send(self, local_file, remote_file, recurse=False, copy_args=None):
410410
:rtype: list(:py:class:`gevent.Greenlet`) of greenlets for remote copy
411411
commands.
412412
413-
:raises: :py:class:`pss.exceptions.SCPError` on errors copying file.
413+
:raises: :py:class:`pssh.exceptions.SCPError` on errors copying file.
414414
:raises: :py:class:`OSError` on local OS errors like permission denied.
415415
"""
416416
copy_args = [{'local_file': local_file,
@@ -482,7 +482,7 @@ def scp_recv(self, remote_file, local_file, recurse=False, copy_args=None,
482482
local_file and recurse is not set.
483483
:raises: :py:class:`pssh.exceptions.HostArgumentError` on number of
484484
per-host copy arguments not equal to number of hosts.
485-
:raises: :py:class:`pss.exceptions.SCPError` on errors copying file.
485+
:raises: :py:class:`pssh.exceptions.SCPError` on errors copying file.
486486
:raises: :py:class:`OSError` on local OS errors like permission denied.
487487
488488
.. note ::

‎pssh/clients/native/single.py‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -397,7 +397,7 @@ def copy_file(self, local_file, remote_file, recurse=False, sftp=None):
397397
398398
:raises: :py:class:`ValueError` when a directory is supplied to
399399
``local_file`` and ``recurse`` is not set
400-
:raises: :py:class:`pss.exceptions.SFTPError` on SFTP initialisation
400+
:raises: :py:class:`pssh.exceptions.SFTPError` on SFTP initialisation
401401
errors
402402
:raises: :py:class:`pssh.exceptions.SFTPIOError` on I/O errors writing
403403
via SFTP
@@ -487,7 +487,7 @@ def copy_remote_file(self, remote_file, local_file, recurse=False,
487487
488488
:raises: :py:class:`ValueError` when a directory is supplied to
489489
``local_file`` and ``recurse`` is not set
490-
:raises: :py:class:`pss.exceptions.SFTPError` on SFTP initialisation
490+
:raises: :py:class:`pssh.exceptions.SFTPError` on SFTP initialisation
491491
errors
492492
:raises: :py:class:`pssh.exceptions.SFTPIOError` on I/O errors reading
493493
from SFTP
@@ -619,7 +619,7 @@ def scp_send(self, local_file, remote_file, recurse=False, sftp=None):
619619
620620
:raises: :py:class:`ValueError` when a directory is supplied to
621621
``local_file`` and ``recurse`` is not set
622-
:raises: :py:class:`pss.exceptions.SFTPError` on SFTP initialisation
622+
:raises: :py:class:`pssh.exceptions.SFTPError` on SFTP initialisation
623623
errors
624624
:raises: :py:class:`pssh.exceptions.SFTPIOError` on I/O errors writing
625625
via SFTP

0 commit comments

Comments
(0)

AltStyle によって変換されたページ (->オリジナル) /