aboutsummaryrefslogtreecommitdiff
path: root/pyasn1/codec/der/decoder.py
diff options
context:
space:
mode:
authorIlya Etingof <etingof@gmail.com>2017-10-21 16:07:17 +0200
committerGitHub <noreply@github.com>2017-10-21 16:07:17 +0200
commit262793a79cad797601fa855eec1e1020e1a534cb (patch)
treec8ef7e3d079887a4aaf9b87e662787f47785a191 /pyasn1/codec/der/decoder.py
parent69c29f0522fe118262c813005590fbb256dfd679 (diff)
downloadpyasn1-262793a79cad797601fa855eec1e1020e1a534cb.tar.gz
Add more content to docs (#96)
* minor fixes to RsT docstrings * more explanations in the docs, better linkage * cosmetic fixes to NamedValues() docstring
Diffstat (limited to 'pyasn1/codec/der/decoder.py')
-rw-r--r--pyasn1/codec/der/decoder.py6
1 files changed, 4 insertions, 2 deletions
diff --git a/pyasn1/codec/der/decoder.py b/pyasn1/codec/der/decoder.py
index 4977a05..1da37a0 100644
--- a/pyasn1/codec/der/decoder.py
+++ b/pyasn1/codec/der/decoder.py
@@ -43,15 +43,17 @@ class Decoder(decoder.Decoder):
#: Turns DER octet stream into an ASN.1 object.
#:
-#: Takes DER octetstream and decode it into an ASN.1 object
+#: Takes DER octet-stream and decode it into an ASN.1 object
#: (e.g. :py:class:`~pyasn1.type.base.PyAsn1Item` derivative) which
#: may be a scalar or an arbitrary nested structure.
#:
#: Parameters
#: ----------
#: substrate: :py:class:`bytes` (Python 3) or :py:class:`str` (Python 2)
-#: DER octetstream
+#: DER octet-stream
#:
+#: Keyword Args
+#: ------------
#: asn1Spec: any pyasn1 type object e.g. :py:class:`~pyasn1.type.base.PyAsn1Item` derivative
#: A pyasn1 type object to act as a template guiding the decoder. Depending on the ASN.1 structure
#: being decoded, *asn1Spec* may or may not be required. Most common reason for