[tor-commits] [bridgedb/master] Start documenting sub-hashring ivars in Bridges.BridgeRing class.

[isis at torproject.org]

commit bf25c8b3a2ec23a5df653145e7930b306ecf9b9b
Author: Isis Lovecruft <isis at torproject.org>
Date:   Fri Nov 15 13:24:02 2013 +0000

    Start documenting sub-hashring ivars in Bridges.BridgeRing class.
---
 lib/bridgedb/Bridges.py |    5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)

diff --git a/lib/bridgedb/Bridges.py b/lib/bridgedb/Bridges.py
index 8e28e7b..d77e632 100644
--- a/lib/bridgedb/Bridges.py
+++ b/lib/bridgedb/Bridges.py
@@ -706,7 +706,10 @@ class BridgeRing(BridgeHolder):
     ##   sortedKeys: a list of all the hmacs, in order.
     ##   name: a string to represent this ring in the logs.
     def __init__(self, key, answerParameters=None):
-        """Create a new BridgeRing, using key as its hmac key."""
+        """Create a new BridgeRing, using key as its hmac key.
+
+        :ivar list subrings: XXX
+        """
         self.bridges = {}
         self.bridgesByID = {}
         self.hmac = get_hmac_fn(key, hex=False)