[tor-commits] [bridgedb/develop] Rewrite module docstring for lib/bridgedb/captcha.py.

[isis at torproject.org]

commit e3595b84d983f40b6e2693839f27d39bb3c00157
Author: Isis Lovecruft <isis at torproject.org>
Date:   Fri Feb 28 01:03:38 2014 +0000

    Rewrite module docstring for lib/bridgedb/captcha.py.
---
 lib/bridgedb/captcha.py |   19 +++++++++++++++++--
 1 file changed, 17 insertions(+), 2 deletions(-)

diff --git a/lib/bridgedb/captcha.py b/lib/bridgedb/captcha.py
index 9936343..f70fa3f 100644
--- a/lib/bridgedb/captcha.py
+++ b/lib/bridgedb/captcha.py
@@ -13,8 +13,23 @@
 # :license: see LICENSE for licensing information
 #_____________________________________________________________________________
 
-"""
-This module wraps the recaptcha api and proxies requests to protect privacy.
+"""This module implements various methods for obtaining or creating CAPTCHAs.
+
+**Module Overview:**
+
+..
+  captcha
+   |_RaptchaKeyError
+   \_Raptcha - Class for obtaining reCaptcha images and challenge strings
+..
+
+There are two types of CAPTCHAs which BridgeDB knows how to serve: those
+obtained by from a reCaptcha_ API server with
+:class:`~bridgedb.captcha.Raptcha`, and those which have been generated with
+gimp-captcha_ and then cached locally.
+
+.. _reCaptcha : https://code.google.com/p/recaptcha/
+.. _gimp-captcha: https://github.com/isislovecruft/gimp-captcha
 """
 
 from recaptcha.client import captcha as recaptcha