commit 122fad73e14e1ae7de73691ab002923690c4f93d Author: Isis Lovecruft isis@torproject.org Date: Sun Jan 5 17:31:55 2014 +0000
Update docstring for bridgedb.Bridges.FilteredBridgeSplitter.prepopulateRings(). --- lib/bridgedb/Bridges.py | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-)
diff --git a/lib/bridgedb/Bridges.py b/lib/bridgedb/Bridges.py index be88001..c59d5ee 100644 --- a/lib/bridgedb/Bridges.py +++ b/lib/bridgedb/Bridges.py @@ -993,13 +993,16 @@ class FilteredBridgeSplitter(BridgeHolder):
:type subring: :class:`BridgeHolder` :param subring: The subring to add. - :param string ringname: A unique name for identifying the new - subring. + :param str ringname: A unique name for identifying the new subring. :param filterFn: A function whose input is a :class:`Bridge`, and - returns True/False based on some filtration criteria. + returns True/False based on some filtration criteria. :type populate_from: iterable or None :param populate_from: A group of :class:`Bridge`s. If given, the newly - added subring will be populated with these bridges. + added subring will be populated with these + bridges. + :rtype: bool + :returns: False if there was a problem adding the subring, True + otherwise. """ if not isinstance(subring, BridgeHolder): logging.fatal("Can't add '%s' to %s because '%s' isn't a hashring."