summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorIlya Etingof <etingof@gmail.com>2019-10-01 09:04:50 +0200
committerGitHub <noreply@github.com>2019-10-01 09:04:50 +0200
commit5e5cd761531a32eba2c8e80789358830e83fd66a (patch)
tree340311b124c164025ec7178dd7a274c46c610170
parent4f644c59bf3ec34a3a8b9cd045dfd7cd1735259f (diff)
downloadpyasn1-git-5e5cd761531a32eba2c8e80789358830e83fd66a.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