[tor-commits] [bridgedb/master] Add docstrings for HTTPServer.render() and getBridgeRequestAnswer().

[isis@xxxxxxxxxxxxxx]

commit 2bb82e704d2fada7339154586aa95d23add3437f
Author: Isis Lovecruft <isis@xxxxxxxxxxxxxx>
Date:   Sun Jan 5 17:41:09 2014 +0000

    Add docstrings for HTTPServer.render() and getBridgeRequestAnswer().
---
 lib/bridgedb/HTTPServer.py |   11 ++++++++++-
 1 file changed, 10 insertions(+), 1 deletion(-)

diff --git a/lib/bridgedb/HTTPServer.py b/lib/bridgedb/HTTPServer.py
index 3384beb..8083bf1 100644
--- a/lib/bridgedb/HTTPServer.py
+++ b/lib/bridgedb/HTTPServer.py
@@ -148,10 +148,19 @@ class WebResource(twisted.web.resource.Resource):
         self.domains = domains
 
     def render(self, request):
+        """Render a response for a client HTTP request.
+
+        Presently, this method merely returns :meth:`getBridgeRequestAnswer`.
+        """
         return self.getBridgeRequestAnswer(request)
 
     def getBridgeRequestAnswer(self, request):
-        """ returns a response to a bridge request """
+        """Respond to a client HTTP request for bridges.
+
+        :type request: :api:`twisted.web.http.Request`
+        :param request: A ``Request`` object containing the HTTP method, full
+                        URI, and any URL/POST arguments and headers present.
+        """
         interval = self.schedule.getInterval(time.time())
         bridges = ( )
         ip = None



_______________________________________________
tor-commits mailing list
tor-commits@xxxxxxxxxxxxxxxxxxxx
https://lists.torproject.org/cgi-bin/mailman/listinfo/tor-commits