diff options
| author | Jeff Forcier <jeff@bitprophet.org> | 2022-03-11 11:36:52 -0500 |
|---|---|---|
| committer | Jeff Forcier <jeff@bitprophet.org> | 2022-03-11 11:36:52 -0500 |
| commit | 58b56875e77be6c2b6b65bbec7300a16c6fd5573 (patch) | |
| tree | 360bb6f128ddfa9dda750c8ae721df0f36447b5e | |
| parent | a318255e18accb7448ef76338b36483b06f40b4e (diff) | |
Clarify SFTPClient.open() docs re: actual behavior of BufferedFile
Closes #2000
| -rw-r--r-- | paramiko/sftp_client.py | 4 |
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. |