summaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
authorw3iBStime <brett.stime@nativex.com>2014-06-19 15:26:53 -0500
committerJeff Forcier <jeff@bitprophet.org>2014-08-25 23:27:09 -0700
commit1fa69c7003bac49c22721ac694fe399f369ece8a (patch)
tree59b9f4d3d94118cf03e752511c6b228d44aa629c
parent77919c6c25d9016c74537ea9b901cedc19050983 (diff)
Updating doco for sftp_client.put()
Adding a note to indicate that the remotepath should include a filename.
-rw-r--r--paramiko/sftp_client.py4
1 files changed, 3 insertions, 1 deletions
diff --git a/paramiko/sftp_client.py b/paramiko/sftp_client.py
index 2ff2d51d..99a29e36 100644
--- a/paramiko/sftp_client.py
+++ b/paramiko/sftp_client.py
@@ -564,7 +564,9 @@ class SFTPClient(BaseSFTP):
The SFTP operations use pipelining for speed.
:param str localpath: the local file to copy
- :param str remotepath: the destination path on the SFTP server
+ :param str remotepath: the destination path on the SFTP server. Note
+ that the filename should be included. Only specifying a directory
+ may result in an error.
:param callable callback:
optional callback function (form: ``func(int, int)``) that accepts
the bytes transferred so far and the total bytes to be transferred