commit 34d61788f471091bb7d466bedd800d98d818517c Author: Isis Lovecruft isis@torproject.org Date: Mon May 5 19:25:47 2014 +0000
Sphinxify docstring for EmailBasedDistributor.getBridgesForEmail(). --- lib/bridgedb/Dist.py | 13 +++++++++---- 1 file changed, 9 insertions(+), 4 deletions(-)
diff --git a/lib/bridgedb/Dist.py b/lib/bridgedb/Dist.py index 984dd59..1596fd1 100644 --- a/lib/bridgedb/Dist.py +++ b/lib/bridgedb/Dist.py @@ -380,10 +380,15 @@ class EmailBasedDistributor(Distributor): def getBridgesForEmail(self, emailaddress, epoch, N=1, parameters=None, countryCode=None, bridgeFilterRules=None): """Return a list of bridges to give to a user. - emailaddress -- the user's email address, as given in a from line. - 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 emailaddress: The user's email address, as given in a + :header:`From:` line. + :param 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. + :param parameters: DOCDOC + :param countryCode: DOCDOC + :param bridgeFilterRules: DOCDOC """ if not bridgeFilterRules: bridgeFilterRules=[]