From 2911db92545262149dfd796d8434b7b41fd37fc2 Mon Sep 17 00:00:00 2001 From: Sergey Matveev Date: Wed, 27 Dec 2017 13:45:44 +0300 Subject: [PATCH] Various documentation fixes --- pyderasn.py | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/pyderasn.py b/pyderasn.py index 3afaf60..f2ef0d7 100755 --- a/pyderasn.py +++ b/pyderasn.py @@ -68,7 +68,7 @@ ____ Most types in ASN.1 has specific tag for them. ``Obj.tag_default`` is the default tag used during coding process. You can override it with either ``IMPLICIT`` (using ``impl`` keyword argument), or -``EXPLICIT`` one (using ``expl`` keyword argument). Both arguments takes +``EXPLICIT`` one (using ``expl`` keyword argument). Both arguments take raw binary string, containing that tag. You can **not** set implicit and explicit tags simultaneously. @@ -88,10 +88,10 @@ number. Pay attention that explicit tags always have *constructed* tag Implicit tag is not explicitly shown. -Two object of the same type, but with different implicit/explicit tags +Two objects of the same type, but with different implicit/explicit tags are **not** equal. -You can get objects effective tag (either default or implicited) through +You can get object's effective tag (either default or implicited) through ``tag`` property. You can decode it using :py:func:`pyderasn.tag_decode` function:: @@ -159,12 +159,12 @@ raised. Common methods ______________ -All objects have ``ready`` boolean property, that tells if it is ready -to be encoded. If that kind of action is performed on unready object, -then :py:exc:`pyderasn.ObjNotReady` exception will be raised. +All objects have ``ready`` boolean property, that tells if object is +ready to be encoded. If that kind of action is performed on unready +object, then :py:exc:`pyderasn.ObjNotReady` exception will be raised. -All objects have ``copy()`` method, returning its copy, that can be safely -mutated. +All objects have ``copy()`` method, that returns their copy, that can be +safely mutated. .. _decoding: @@ -256,8 +256,8 @@ Following types can be automatically decoded (DEFINED BY): ``Any``/``OctetString``-s When any of those fields is automatically decoded, then ``.defined`` -attribute contains ``(OID, value)`` tuple. OID tell by which OID it was -defined, ``value`` contains corresponding decoded value. For example +attribute contains ``(OID, value)`` tuple. ``OID`` tells by which OID it +was defined, ``value`` contains corresponding decoded value. For example above, ``content_info["content"].defined == (id_signedData, signed_data)``. @@ -324,8 +324,8 @@ of ``PKIResponse``:: Pay attention for :py:func:`pyderasn.decode_path_defby` and ``any``. First function is useful for path construction when some automatic -decoding is already done. ``any`` is used for human readability and -means literally any value it meet -- useful for sequence and set of-s. +decoding is already done. ``any`` means literally any value it meet -- +useful for SEQUENCE/SET OF-s. Primitive types --------------- -- 2.44.0