Skip to content

Commit 8df29c9

Browse files
author
Kincaid Savoie
committed
update docstring comments for copy_file and _copy_dir
1 parent d14f719 commit 8df29c9

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

pssh/ssh_client.py

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -286,7 +286,7 @@ def mkdir(self, sftp, directory):
286286
return True
287287

288288
def _copy_dir(self, local_dir, remote_dir):
289-
"""Calls copy_file on every file in the specified directory, copying
289+
"""Call copy_file on every file in the specified directory, copying
290290
them to the specified remote directory."""
291291
file_list = os.listdir(local_dir)
292292
for file_name in file_list:
@@ -306,6 +306,9 @@ def copy_file(self, local_file, remote_file, recurse=False):
306306
:type remote_file: str
307307
:param recurse: Whether or not to descend into directories recursively.
308308
:type recurse: bool
309+
310+
:raises: :mod:'ValueError' when a directory is supplied to local_file \
311+
and recurse is not set
309312
"""
310313
if os.path.isdir(local_file) and recurse:
311314
return self._copy_dir(local_file, remote_file)

0 commit comments

Comments
 (0)