commit 0e50c9920518c13eed361bd956f505fb26eb5bf9 Author: Isis Lovecruft <isis@torproject.org> Date: Sat Jan 11 15:20:54 2014 +0000 Sphinxify and improve Dist.IPBasedDistributor.getBridgesForIP docstring. --- lib/bridgedb/Dist.py | 14 ++++++++++---- 1 file changed, 10 insertions(+), 4 deletions(-) diff --git a/lib/bridgedb/Dist.py b/lib/bridgedb/Dist.py index 5fc8094..57d95bb 100644 --- a/lib/bridgedb/Dist.py +++ b/lib/bridgedb/Dist.py @@ -166,10 +166,16 @@ class IPBasedDistributor(bridgedb.Bridges.BridgeHolder): def getBridgesForIP(self, ip, epoch, N=1, countryCode=None, bridgeFilterRules=None): """Return a list of bridges to give to a user. - ip -- the user's IP address, as a dotted quad. - epoch -- the time period when we got this request. This can - be any string, so long as it changes with every period. - N -- the number of bridges to try to give back. + + :param str ip: The user's IP address, as a dotted quad. + :param str epoch: The time period when we got this request. This can + be any string, so long as it changes with every + period. + :param int N: The number of bridges to try to give back. (default: 1) + :param str countryCode: DOCDOC (default: None) + :param list bridgeFilterRules: A list of callables used filter the + bridges returned in the response to the + client. See :mod:`~bridgedb.Filters`. """ if not bridgeFilterRules: bridgeFilterRules=[] logging.debug("getBridgesForIP(%s, %s, %s, %s",