[tor-commits] [stem/master] Document DigestHashType

[atagar at torproject.org]

commit fc229c7ad1e0bf05ccdabecd7f8ca1d3be2d6324
Author: Damian Johnson <atagar at torproject.org>
Date:   Tue Nov 13 17:37:39 2018 -0800

    Document DigestHashType
    
    Simple enum so not much to be said.
---
 stem/descriptor/__init__.py | 14 ++++++++++++++
 1 file changed, 14 insertions(+)

diff --git a/stem/descriptor/__init__.py b/stem/descriptor/__init__.py
index 943106c4..bb890afd 100644
--- a/stem/descriptor/__init__.py
+++ b/stem/descriptor/__init__.py
@@ -19,6 +19,20 @@ Package for parsing and processing descriptor data.
     |- get_unrecognized_lines - unparsed descriptor content
     +- __str__ - string that the descriptor was made from
 
+.. data:: DigestHashType (enum)
+
+  .. versionadded:: 1.8.0
+
+  Hashing algorithm used by tor for descriptor digests. We drop trailing '='
+  hash padding to match Tor.
+
+  =================== ===========
+  DigestHashType      Description
+  =================== ===========
+  SHA1                SHA1 hash
+  SHA256              SHA256 hash
+  =================== ===========
+
 .. data:: DocumentHandler (enum)
 
   Ways in which we can parse a