ASN.1: minor improvements to conversion docstrings

awwad · awwad · commit a0719ddddbd0 · 2018-11-08T16:36:51.000-05:00
Signed-off-by: Sebastien Awwad &lt;sebastien.awwad@gmail.com&gt;
diff --git a/tuf/encoding/asn1_convert.py b/tuf/encoding/asn1_convert.py
@@ -243,7 +243,9 @@ def public_key_to_pyasn1(public_key_dict):
 
 def hex_str_to_pyasn1_octets(hex_string):
   """
-
+  Convert a hex string into a pyasn1 OctetString object.
+  Example arg: '12345abcd'  (string / unicode)
+  Returns a pyasn1.type.univ.OctetString object.
   """
   # TODO: Verify hex_string type.
 
@@ -273,8 +275,8 @@ def hex_str_to_pyasn1_octets(hex_string):
 
 def hex_str_from_pyasn1_octets(octets_pyasn1):
   """
-  Convert a pyasn1 OctetString object into a hex string.
-  Example return:   '4b394ae2'
+  Convert a pyasn1.type.univ.OctetString object into a hex string.
+  Example return:   '4b394ae2' (string / unicode)
   Raises Error() if an individual octet's supposed integer value is out of
   range (0 <= x <= 255).
   """
diff --git a/tuf/encoding/asn1_metadata_definitions.py b/tuf/encoding/asn1_metadata_definitions.py
@@ -110,8 +110,8 @@ class HashesContainer(ac.Sequence):
   """
   Single-element, vapid wrapper for Hashes, solely to match structure of the
   TUF-internal metadata. (This layer could be removed from both metadata
-  formats without loss of semantics or clarity, but would break backward
-  compatibility.)
+  formats to result in a clearer definition without change to the implicit
+  semantics, but would break backward compatibility.)
   Conceptual ASN.1 structure (Python pseudocode):
       {'hashes': [
         {'function': 'sha256', 'digest': '...'},
