[tor-commits] [bridgedb/master] Add docstring to FilteredBridgeSplitter.insert().

[isis at torproject.org]

commit f6a04be064e352ad6678fe3cba7e9a83941d5c82
Author: Isis Lovecruft <isis at torproject.org>
Date:   Fri Nov 15 13:32:42 2013 +0000

    Add docstring to FilteredBridgeSplitter.insert().
---
 lib/bridgedb/Bridges.py |    8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/lib/bridgedb/Bridges.py b/lib/bridgedb/Bridges.py
index 6ffd116..d58d7f0 100644
--- a/lib/bridgedb/Bridges.py
+++ b/lib/bridgedb/Bridges.py
@@ -1023,6 +1023,14 @@ class FilteredBridgeSplitter(BridgeHolder):
         self.filterRings = {}
 
     def insert(self, bridge):
+        """Insert a bridge into all appropriate sub-hashrings.
+
+        For all sub-hashrings, the ``bridge`` will only be added iff it passes
+        the filter functions for that sub-hashring.
+
+        :type bridge: :class:`~bridgedb.Bridges.Bridge`
+        :param bridge: The bridge to add.
+        """
         if not bridge.running:
             logging.debug("insert non-running bridge %s" % bridge.getID())
             return