[tor-commits] [bridgedb/develop] Document `request` parameter in ReCaptchaProtectedResource.getCaptchaImage().

[isis at torproject.org]

commit 29e95448ae36b15df629ae8b904ca357e901a3be
Author: Isis Lovecruft <isis at torproject.org>
Date:   Wed Mar 12 00:32:46 2014 +0000

    Document `request` parameter in ReCaptchaProtectedResource.getCaptchaImage().
---
 lib/bridgedb/HTTPServer.py |    3 +++
 1 file changed, 3 insertions(+)

diff --git a/lib/bridgedb/HTTPServer.py b/lib/bridgedb/HTTPServer.py
index 0ff9818..228f350 100644
--- a/lib/bridgedb/HTTPServer.py
+++ b/lib/bridgedb/HTTPServer.py
@@ -368,6 +368,9 @@ class ReCaptchaProtectedResource(CaptchaProtectedResource):
     def getCaptchaImage(self, request):
         """Get a CAPTCHA image from the remote reCaptcha server.
 
+        :type request: :api:`twisted.web.http.Request`
+        :param request: A client's initial request for some other resource
+            which is protected by this one (i.e. protected by a CAPTCHA).
         :returns: A 2-tuple of ``(image, challenge)``, where::
             - ``image`` is a string holding a binary, JPEG-encoded image.
             - ``challenge`` is a unique string associated with the request.