[tor-commits] [bridgedb/master] Update docstring parameters for IPBasedDistributor.getBridgesForIP().

[isis at torproject.org]

commit 7293758a3cd28db210809e338811b308324f66a3
Author: Isis Lovecruft <isis at torproject.org>
Date:   Sun Jan 12 04:00:53 2014 +0000

    Update docstring parameters for IPBasedDistributor.getBridgesForIP().
---
 lib/bridgedb/Dist.py |    5 +++++
 1 file changed, 5 insertions(+)

diff --git a/lib/bridgedb/Dist.py b/lib/bridgedb/Dist.py
index 1758021..6e9c436 100644
--- a/lib/bridgedb/Dist.py
+++ b/lib/bridgedb/Dist.py
@@ -221,6 +221,11 @@ class IPBasedDistributor(Distributor):
         :param list bridgeFilterRules: A list of callables used filter the
                                        bridges returned in the response to the
                                        client. See :mod:`~bridgedb.Filters`.
+        :rtype: list
+        :return: A list of :class:`~bridgedb.Bridges.Bridge`s to include in
+                 the response. See
+                 :meth:`bridgedb.HTTPServer.WebResource.getBridgeRequestAnswer`
+                 for an example of how this is used.
         """
         logging.info("Attempting to return %d bridges to client %s..."
                      % (N, Util.logSafely(ip)))