[tor-commits] [bridgedb/master] Add module docstring for bridgedb.parse.fingerprint.

[isis at torproject.org]

commit 217f8e2785c02d1e8edf784aac9dd9a1b83978a9
Author: Isis Lovecruft <isis at torproject.org>
Date:   Thu Jun 18 04:51:30 2015 +0000

    Add module docstring for bridgedb.parse.fingerprint.
---
 lib/bridgedb/parse/fingerprint.py |   18 ++++++++++++++++++
 1 file changed, 18 insertions(+)

diff --git a/lib/bridgedb/parse/fingerprint.py b/lib/bridgedb/parse/fingerprint.py
index f825271..bf12ee5 100644
--- a/lib/bridgedb/parse/fingerprint.py
+++ b/lib/bridgedb/parse/fingerprint.py
@@ -10,6 +10,24 @@
 # :license: see LICENSE for licensing information
 #_____________________________________________________________________________
 
+"""Utility functions for converting between various relay fingerprint formats,
+and checking their validity.
+
+.. py:module:: bridgedb.parse.fingerprints
+    :synopsis: Parsers for Tor Bridge fingerprints.
+
+.. todo: This module is very small; it could possibly be combined with another
+    module, e.g. :mod:`bridgedb.parse.descriptors`.
+
+bridgedb.parse.fingerprints
+============================
+::
+
+ toHex - Convert a fingerprint from its binary representation to hexadecimal.
+ fromHex - Convert a fingerprint from hexadecimal to binary.
+ isValidFingerprint - Validate a fingerprint.
+..
+"""
 
 import binascii
 import logging