[tor-commits] [bridgedb/master] Add a docstring to bridgedb.Bridges.BridgeRingParameters.

[isis at torproject.org]

commit d106b9e15d74214b0fc55d6f2957985e139ca69f
Author: Isis Lovecruft <isis at torproject.org>
Date:   Fri Nov 15 13:20:37 2013 +0000

    Add a docstring to bridgedb.Bridges.BridgeRingParameters.
---
 lib/bridgedb/Bridges.py |   13 ++++++++++++-
 1 file changed, 12 insertions(+), 1 deletion(-)

diff --git a/lib/bridgedb/Bridges.py b/lib/bridgedb/Bridges.py
index 3323989..4627a88 100644
--- a/lib/bridgedb/Bridges.py
+++ b/lib/bridgedb/Bridges.py
@@ -646,7 +646,18 @@ class BridgeHolder(object):
         pass
 
 class BridgeRingParameters(object):
-    """DOCDOC"""
+    """Store validated settings on minimum number of Bridges with certain
+    attributes which should be included in any generated subring of a
+    hashring.
+
+    :ivar list needPorts: List of two-tuples of desired port numbers and their
+        respective minimums.
+    :ivar list needFlags: List of two-tuples of desired flags_ assigned to a
+        Bridge by the Bridge DirAuth.
+
+    .. _flags: https://gitweb.torproject.org/torspec.git/blob/HEAD:/dir-spec.txt#l1696
+    """
+
     def __init__(self, needPorts=(), needFlags=()):
         """DOCDOC takes list of port, count"""
         for port,count in needPorts: