commit ba50829d94e7fdbd8d8498aca15273fb75e60dcf Author: Isis Lovecruft isis@torproject.org Date: Sat Mar 28 02:17:12 2015 +0000
Document countryCode parameter for IPBasedDistributor.getBridgesForIP(). --- lib/bridgedb/Dist.py | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-)
diff --git a/lib/bridgedb/Dist.py b/lib/bridgedb/Dist.py index 20f27bc..ded8297 100644 --- a/lib/bridgedb/Dist.py +++ b/lib/bridgedb/Dist.py @@ -243,7 +243,11 @@ class IPBasedDistributor(Distributor): 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 str countryCode: The two-letter geoip country code of the + client's IP address. If given, the client will be placed in that + "area". Clients within the same area receive the same bridges per + period. If not given, the **ip** is truncated to it's CIDR /24 + representation and used as the "area". (default: None) :param list bridgeFilterRules: A list of callables used filter the bridges returned in the response to the client. See :mod:`~bridgedb.Filters`.