From 1b44b804945df5a19e73c0d75321a77438076243 Mon Sep 17 00:00:00 2001 From: Ilya Etingof Date: Sun, 17 Sep 2017 22:53:10 +0200 Subject: documented ASN.1 schema parameter to encoders --- pyasn1/codec/ber/encoder.py | 8 ++++++-- pyasn1/codec/cer/encoder.py | 8 ++++++-- pyasn1/codec/der/encoder.py | 8 ++++++-- 3 files changed, 18 insertions(+), 6 deletions(-) (limited to 'pyasn1/codec') diff --git a/pyasn1/codec/ber/encoder.py b/pyasn1/codec/ber/encoder.py index 492df88..89fcca0 100644 --- a/pyasn1/codec/ber/encoder.py +++ b/pyasn1/codec/ber/encoder.py @@ -623,8 +623,12 @@ class Encoder(object): #: #: Parameters #: ---------- -# value: any pyasn1 object (e.g. :py:class:`~pyasn1.type.base.PyAsn1Item` derivative) -#: A pyasn1 object to encode +#: value: either a Python or pyasn1 object (e.g. :py:class:`~pyasn1.type.base.PyAsn1Item` derivative) +#: A Python or pyasn1 object to encode. If Python object is given, `asnSpec` +#: parameter is required to guide the encoding process. +#: +#: asn1Spec: +#: Optional ASN.1 schema or value object e.g. :py:class:`~pyasn1.type.base.PyAsn1Item` derivative #: #: defMode: :py:class:`bool` #: If `False`, produces indefinite length encoding diff --git a/pyasn1/codec/cer/encoder.py b/pyasn1/codec/cer/encoder.py index 57f532d..af14753 100644 --- a/pyasn1/codec/cer/encoder.py +++ b/pyasn1/codec/cer/encoder.py @@ -253,8 +253,12 @@ class Encoder(encoder.Encoder): #: #: Parameters #: ---------- -# value: any pyasn1 object (e.g. :py:class:`~pyasn1.type.base.PyAsn1Item` derivative) -#: A pyasn1 object to encode +#: value: either a Python or pyasn1 object (e.g. :py:class:`~pyasn1.type.base.PyAsn1Item` derivative) +#: A Python or pyasn1 object to encode. If Python object is given, `asnSpec` +#: parameter is required to guide the encoding process. +#: +#: asn1Spec: +#: Optional ASN.1 schema or value object e.g. :py:class:`~pyasn1.type.base.PyAsn1Item` derivative #: #: defMode: :py:class:`bool` #: If `False`, produces indefinite length encoding diff --git a/pyasn1/codec/der/encoder.py b/pyasn1/codec/der/encoder.py index ca0b660..ac0bfb5 100644 --- a/pyasn1/codec/der/encoder.py +++ b/pyasn1/codec/der/encoder.py @@ -65,8 +65,12 @@ class Encoder(encoder.Encoder): #: #: Parameters #: ---------- -# value: any pyasn1 object (e.g. :py:class:`~pyasn1.type.base.PyAsn1Item` derivative) -#: A pyasn1 object to encode +#: value: either a Python or pyasn1 object (e.g. :py:class:`~pyasn1.type.base.PyAsn1Item` derivative) +#: A Python or pyasn1 object to encode. If Python object is given, `asnSpec` +#: parameter is required to guide the encoding process. +#: +#: asn1Spec: +#: Optional ASN.1 schema or value object e.g. :py:class:`~pyasn1.type.base.PyAsn1Item` derivative #: #: defMode: :py:class:`bool` #: If `False`, produces indefinite length encoding -- cgit v1.2.1