summaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
authorJeff Forcier <jeff@bitprophet.org>2022-03-11 11:36:55 -0500
committerJeff Forcier <jeff@bitprophet.org>2022-03-11 11:36:55 -0500
commit6e2dcda476ef6b0a360a7b8e01088b1cbef94fcf (patch)
tree58ac1757708e7aa3276fade6c2a8850f91ca7306
parentb4bd81dce17d23b3e402b7fd492bb2ebd30b284c (diff)
parent37bd541b54f56e06b75691bb6f8338eed2a859a5 (diff)
Merge branch '2.9'
-rw-r--r--paramiko/sftp_client.py4
1 files changed, 2 insertions, 2 deletions
diff --git a/paramiko/sftp_client.py b/paramiko/sftp_client.py
index 6294fb48..d6c3a70d 100644
--- a/paramiko/sftp_client.py
+++ b/paramiko/sftp_client.py
@@ -344,13 +344,13 @@ class SFTPClient(BaseSFTP, ClosingContextManager):
``O_EXCL`` flag in posix.
The file will be buffered in standard Python style by default, but
- can be altered with the ``bufsize`` parameter. ``0`` turns off
+ can be altered with the ``bufsize`` parameter. ``<=0`` turns off
buffering, ``1`` uses line buffering, and any number greater than 1
(``>1``) uses that specific buffer size.
:param str filename: name of the file to open
:param str mode: mode (Python-style) to open in
- :param int bufsize: desired buffering (-1 = default buffer size)
+ :param int bufsize: desired buffering (default: ``-1``)
:return: an `.SFTPFile` object representing the open file
:raises: ``IOError`` -- if the file could not be opened.