diff options
author | Sergey Skripnick <sskripnick@mirantis.com> | 2015-10-12 12:32:59 +0200 |
---|---|---|
committer | Jeff Forcier <jeff@bitprophet.org> | 2015-11-02 12:54:27 -0800 |
commit | 0683452c622e95c2b3a775621d3ace7a5afcc152 (patch) | |
tree | f07db0121747921fc309bffb86f41157cd91ccc3 /paramiko/buffered_pipe.py | |
parent | fcacbe4620a867acedf33da7a069b09e4a8d370d (diff) | |
download | paramiko-0683452c622e95c2b3a775621d3ace7a5afcc152.tar.gz |
Fix data types in some docstrings
Some methods return `bytes` type, but documentation said `str`.
Also method BufferedPipe.feed accept both types.
Diffstat (limited to 'paramiko/buffered_pipe.py')
-rw-r--r-- | paramiko/buffered_pipe.py | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/paramiko/buffered_pipe.py b/paramiko/buffered_pipe.py index ac35b3e1..d5fe164e 100644 --- a/paramiko/buffered_pipe.py +++ b/paramiko/buffered_pipe.py @@ -81,7 +81,7 @@ class BufferedPipe (object): Feed new data into this pipe. This method is assumed to be called from a separate thread, so synchronization is done. - :param data: the data to add, as a `str` + :param data: the data to add, as a `str` or `bytes` """ self._lock.acquire() try: @@ -125,7 +125,7 @@ class BufferedPipe (object): :param int nbytes: maximum number of bytes to read :param float timeout: maximum seconds to wait (or ``None``, the default, to wait forever) - :return: the read data, as a `str` + :return: the read data, as a `bytes` :raises PipeTimeout: if a timeout was specified and no data was ready before that |