summaryrefslogtreecommitdiff
path: root/paramiko/buffered_pipe.py
diff options
context:
space:
mode:
authorJeff Forcier <jeff@bitprophet.org>2017-06-05 20:49:29 -0700
committerJeff Forcier <jeff@bitprophet.org>2017-06-05 23:02:31 -0700
commitfd94765e54272706b55e50c692c814d07c8008d1 (patch)
tree8ccbc1e9cf8f878aab6e79b5a08b6271d24aad9e /paramiko/buffered_pipe.py
parent691f6191601366255d55176bcdb103987626cc86 (diff)
downloadparamiko-fd94765e54272706b55e50c692c814d07c8008d1.tar.gz
Move to 'inv sites' style doc nitpicking.
Existing just-warnings setup was old and not as rigorous as my usual. Required a lot of stupid little changes, but now same tooling for all projects, toot toot.
Diffstat (limited to 'paramiko/buffered_pipe.py')
-rw-r--r--paramiko/buffered_pipe.py10
1 files changed, 5 insertions, 5 deletions
diff --git a/paramiko/buffered_pipe.py b/paramiko/buffered_pipe.py
index 9a65cd95..d9f5149d 100644
--- a/paramiko/buffered_pipe.py
+++ b/paramiko/buffered_pipe.py
@@ -90,7 +90,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` or `bytes`
+ :param data: the data to add, as a ``str`` or ``bytes``
"""
self._lock.acquire()
try:
@@ -134,11 +134,11 @@ 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 `bytes`
+ :return: the read data, as a ``str`` or ``bytes``
- :raises PipeTimeout:
- if a timeout was specified and no data was ready before that
- timeout
+ :raises:
+ `.PipeTimeout` -- if a timeout was specified and no data was ready
+ before that timeout
"""
out = bytes()
self._lock.acquire()