summaryrefslogtreecommitdiff
path: root/paramiko/file.py
diff options
context:
space:
mode:
authorJeff Forcier <jeff@bitprophet.org>2023-01-20 16:11:47 -0500
committerJeff Forcier <jeff@bitprophet.org>2023-01-20 16:11:47 -0500
commitcfd4af06dc66a9b0ac8ebd7559f2657acdb77d39 (patch)
tree4a19905172d2ee580962b21bdaf58d946c982654 /paramiko/file.py
parentd29bb48a392be93f24779aa6f04ed87fcdeea5d9 (diff)
downloadparamiko-cfd4af06dc66a9b0ac8ebd7559f2657acdb77d39.tar.gz
Docstring and changelog tweaks, thanks @bskinn!
Diffstat (limited to 'paramiko/file.py')
-rw-r--r--paramiko/file.py4
1 files changed, 3 insertions, 1 deletions
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: