[tor-commits] [bridgedb/master] Update bridgedb.crypto module docstring.

[isis at torproject.org]

commit 5dd8cc2b9488800c8f263807e3eaf6d0f225de08
Author: Isis Lovecruft <isis at torproject.org>
Date:   Mon Apr 21 17:29:46 2014 +0000

    Update bridgedb.crypto module docstring.
---
 lib/bridgedb/crypto.py |   16 +++++++++++-----
 1 file changed, 11 insertions(+), 5 deletions(-)

diff --git a/lib/bridgedb/crypto.py b/lib/bridgedb/crypto.py
index ebab733..cddc108 100644
--- a/lib/bridgedb/crypto.py
+++ b/lib/bridgedb/crypto.py
@@ -10,11 +10,17 @@
 
 """crypto - BridgeDB general cryptographic utilities.
 
-**Module Overview:**
-
-..
+Module Overview:
+````````````````
+::
   crypto
-   |_getKey() - Load the master key from a file, or create a new one.
+   |_getGPGContext() - Get a pre-configured GPGME context.
+   |_getHMAC() - Compute an HMAC with some key for some data.
+   |_getHMACFunc() - Get a callable for producing HMACs with the given key.
+   |_getKey() - Load the master HMAC key from a file, or create a new one.
+   |_getRSAKey() - Load an RSA key from a file, or create a new one.
+   |_gpgSignMessage() - Sign a message string according to a GPGME context.
+   |_writeKeyToFile() - Write to a file readable only by the process owner.
    |
    \_SSLVerifyingContextFactory - OpenSSL.SSL.Context factory which verifies
       |                           certificate chains and matches hostnames.
@@ -23,7 +29,7 @@
       |_getHostnameFromURL() - Parses the hostname from the request URL.
       \_verifyHostname() - Check that the cert CN matches the request
                            hostname.
-
+::
 """
 
 from __future__ import absolute_import