Docstring and changelog tweaks, thanks @bskinn!

paramiko · Jan 20, 2023 · cfd4af0 · cfd4af0
1 parent d29bb48
commit cfd4af0
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 3 deletions.
diff --git a/paramiko/channel.py b/paramiko/channel.py
@@ -828,7 +828,7 @@ def sendall(self, s):
         `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
@@ -102,7 +102,9 @@ def __next__(self):
 
         :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
@@ -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.