[tor-commits] [bridgedb/develop] Document `key` parameter for bridgedb.Bridges.BridgeRing.__init__().

[isis at torproject.org]

commit 8fc3dfc8106c157801f526e7ae6eddad6fd3975b
Author: Isis Lovecruft <isis at torproject.org>
Date:   Wed Mar 12 00:48:05 2014 +0000

    Document `key` parameter for bridgedb.Bridges.BridgeRing.__init__().
---
 lib/bridgedb/Bridges.py |    5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)

diff --git a/lib/bridgedb/Bridges.py b/lib/bridgedb/Bridges.py
index 41925a4..531a842 100644
--- a/lib/bridgedb/Bridges.py
+++ b/lib/bridgedb/Bridges.py
@@ -790,10 +790,11 @@ class BridgeRing(BridgeHolder):
     def __init__(self, key, answerParameters=None):
         """Create a new BridgeRing, using key as its hmac key.
 
-        :param key: DOCDOC
+        :type key: bytes
+        :param key: The HMAC key, generated with
+                    :func:`bridgedb.crypto.getKey`.
         :type answerParameters: :class:`BridgeRingParameters`
         :param answerParameters: DOCDOC
-
         :ivar dict bridges: A dictionary which maps HMAC keys to
                             :class:`~bridgedb.Bridges.Bridge`s.
         :ivar dict bridgesByID: A dictionary which maps raw hash digests of