search

ParallelSSH / ssh2-python

Python bindings for libssh2 C library.
https://parallel-ssh.org
GNU Lesser General Public License v2.1
228 stars 72 forks source link

Wrong documentation? - SFTPHandle.read returns tuple #133

Closed hakaishi closed 3 years ago

hakaishi commented 3 years ago

documentation url: https://ssh2-python.readthedocs.io/en/latest/sftp_handle.html#ssh2.sftp_handle.SFTPHandle.read

Problem: Documentation says that read returns bytes, but it actually returns a tuple of (return code, bytes)

pkittenis commented 3 years ago

Thanks for the interest.

Yes, documentation is wrong, it should be a tuple. PR to update them is welcome.