diff options
| author | Jeff Forcier <jeff@bitprophet.org> | 2023-01-20 16:11:47 -0500 |
|---|---|---|
| committer | Jeff Forcier <jeff@bitprophet.org> | 2023-01-20 16:11:47 -0500 |
| commit | cfd4af06dc66a9b0ac8ebd7559f2657acdb77d39 (patch) | |
| tree | 4a19905172d2ee580962b21bdaf58d946c982654 | |
| parent | d29bb48a392be93f24779aa6f04ed87fcdeea5d9 (diff) | |
Docstring and changelog tweaks, thanks @bskinn!
| -rw-r--r-- | paramiko/channel.py | 2 | ||||
| -rw-r--r-- | paramiko/file.py | 4 | ||||
| -rw-r--r-- | sites/www/changelog.rst | 2 |
3 files changed, 5 insertions, 3 deletions
diff --git a/paramiko/channel.py b/paramiko/channel.py index 0e009eff..2757450b 100644 --- a/paramiko/channel.py +++ b/paramiko/channel.py @@ -828,7 +828,7 @@ class Channel(ClosingContextManager): `send`, this method continues to send data from the given string until either all data has been sent or an error occurs. Nothing is returned. - :param str s: data to send. + :param bytes s: data to send. :raises socket.timeout: if sending stalled for longer than the timeout set by `settimeout`. diff --git a/paramiko/file.py b/paramiko/file.py index b1450ac9..a36abb98 100644 --- a/paramiko/file.py +++ b/paramiko/file.py @@ -102,7 +102,9 @@ class BufferedFile(ClosingContextManager): :raises: ``StopIteration`` -- when the end of the file is reached. - :returns: a line (`str`) read from the file. + :returns: + a line (`str`, or `bytes` if the file was opened in binary mode) + read from the file. """ line = self.readline() if not line: diff --git a/sites/www/changelog.rst b/sites/www/changelog.rst index ed424e29..6a0cff99 100644 --- a/sites/www/changelog.rst +++ b/sites/www/changelog.rst @@ -71,7 +71,7 @@ Changelog 2. So long and thanks for all the fish! .. warning:: - This change is backwards compatible. However, our packaging metadata has + This change is backwards incompatible. However, our packaging metadata has been updated to include ``python_requires``, so this should not cause breakage unless you're on an old installation method that can't read this metadata. |