summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorIlya Etingof <etingof@gmail.com>2019-10-01 09:04:50 +0200
committerIlya Etingof <etingof@gmail.com>2019-11-15 19:39:11 +0100
commit2e6e1ab5d28094dfabcb114a0eca16413ab1ff1b (patch)
tree1b71f765b88676ca804eb0694a74b227fcb42875
parent93e11a2dfded950827ba3393b5a4562270a766da (diff)
downloadpyasn1-git-2e6e1ab5d28094dfabcb114a0eca16413ab1ff1b.tar.gz
Update docstring on streaming.read
Co-Authored-By: Jan Pipek <jan.pipek@gmail.com>
-rw-r--r--pyasn1/codec/streaming.py2
1 files changed, 1 insertions, 1 deletions
diff --git a/pyasn1/codec/streaming.py b/pyasn1/codec/streaming.py
index 1889677..31c40f2 100644
--- a/pyasn1/codec/streaming.py
+++ b/pyasn1/codec/streaming.py
@@ -209,7 +209,7 @@ def read(substrate, size=-1, context=None):
Yields
------
- : :py:class:`bytes` or :py:class:`str` or None
+ : :py:class:`bytes` or :py:class:`str` or :py:class:`SubstrateUnderrunError`
Returns read data or :py:class:`~pyasn1.error.SubstrateUnderrunError`
object if no `size` bytes is readily available in the stream. The
data type depends on Python major version