[tor-commits] [bridgedb/develop] Add documentation to captcha.Captcha class.

[isis at torproject.org]

commit de58663945df01f45d9cbe637fbbaa801c99c869
Author: Isis Lovecruft <isis at torproject.org>
Date:   Tue Mar 11 20:50:10 2014 +0000

    Add documentation to captcha.Captcha class.
---
 lib/bridgedb/captcha.py |    8 +++++++-
 1 file changed, 7 insertions(+), 1 deletion(-)

diff --git a/lib/bridgedb/captcha.py b/lib/bridgedb/captcha.py
index 608882a..728cfaf 100644
--- a/lib/bridgedb/captcha.py
+++ b/lib/bridgedb/captcha.py
@@ -63,7 +63,13 @@ class ICaptcha(Interface):
 
 
 class Captcha(object):
-    """A generic CAPTCHA base class."""
+    """A generic CAPTCHA base class.
+
+    :ivar str image: The CAPTCHA image.
+    :ivar str challenge: A challenge string which should permit checking of
+        the client's CAPTCHA solution in some manner. This should be passed
+        along to the client with the CAPTCHA image.
+    """
     implements(ICaptcha)
 
     def __init__(self):