Re: Proof reading of python-recaptcha description
Vincent Bernat wrote:
> Could someone proofread my description for python-recaptcha
> package. There is a lot of wording of mine so I think there is a lot of
> mistakes.
Comments below (please check my reasoning!); diff attached.
> * Package name : python-recaptcha
> Version : 1.0.2
> Upstream Author : Ben Maurer <support at recaptcha net>
> * URL : http://pypi.python.org/pypi/recaptcha-client
> * License : MIT/X
> Programming Lang: Python
> Description : implementation of reCAPTCHA and Mailhide in Python
This "unpacks" the package name with a minimum of new information.
It's always pretty much self-evident that python-foo is a Python
library of-or-pertaining-to foo; the question is, what is foo?
Description : reCAPTCHA and Mailhide client modules
>
> This Python modules provides a plugin for both reCAPTCHA and reCAPTCHA
> Mailhide.
How many modules, and how many plugins? I'll assume two of each:
These Python modules provide plugins for reCAPTCHA and reCAPTCHA
Mailhide.
>
> reCAPTCHA helps prevent automated abuse of web site (such as comment
> spam or bogus registrations) by using a CAPTCHA to ensure that only
> humans perform certain actions.
Either "abuse of a web site" or (probably) "abuse of web sites".
By the way, this reference to web sites was the only real hint (for
anyone who hadn't heard of a CAPCHA) to the fact that when it talks
about "email addresses" being "delivered" below, it means
commenter-addresses being displayed on a blog or similar.
>
> reCAPTCHA Mailhide allows to obfuscate email addresses such that the
> original email address is delivered only if a reCAPTCHA is solved.
No, you can't drop the object of "allow" like that (make it
something informative). "Deliver" is the wrong word, and the "such
that" and "only if" each have subtly ambiguous scope. Let's see...
reCAPTCHA Mailhide allows web sites to obfuscate email addresses,
revealing them only if a reCAPTCHA is solved.
On the other hand, thanks for not confusing "email message" with
"email address" the way upstream do.
>
> This plugin uses a free (as in free beer) web service that requires to
> register to get an API key. On the other hand, no imaging library or
> complex computation are needed to generate and check CAPTCHA.
Sorry, "requires" needs an object too. Again, introduce an
informative one to clarify that the registration is per-site, not
per-visitor...
And "libraries", "computations" - zero items, plural...
This plugin accesses a free (as in free beer) web service that requires
sites running the reCAPCHA client to register for an API key. On the
other hand, no imaging libraries or complex computations are needed to
generate and check CAPTCHAs.
--
JBR with qualifications in linguistics, experience as a Debian
sysadmin, and probably no clue about this particular package
--- recaptcha.old 2008-08-23 09:54:25.000000000 +0100
+++ recaptcha.new 2008-08-23 09:54:55.000000000 +0100
@@ -4,18 +4,19 @@
* URL : http://pypi.python.org/pypi/recaptcha-client
* License : MIT/X
Programming Lang: Python
- Description : implementation of reCAPTCHA and Mailhide in Python
+ Description : reCAPTCHA and Mailhide client modules
-This Python modules provides a plugin for both reCAPTCHA and reCAPTCHA
+These Python modules provide plugins for both reCAPTCHA and reCAPTCHA
Mailhide.
-reCAPTCHA helps prevent automated abuse of web site (such as comment
+reCAPTCHA helps prevent automated abuse of web sites (such as comment
spam or bogus registrations) by using a CAPTCHA to ensure that only
humans perform certain actions.
-reCAPTCHA Mailhide allows to obfuscate email addresses such that the
-original email address is delivered only if a reCAPTCHA is solved.
+reCAPTCHA Mailhide allows web sites to obfuscate email addresses,
+revealing them only if a reCAPTCHA is solved.
-This plugin uses a free (as in free beer) web service that requires to
-register to get an API key. On the other hand, no imaging library or
-complex computation are needed to generate and check CAPTCHA.
+This plugin accesses a free (as in free beer) web service that requires
+sites running the reCAPCHA client to register for an API key. On the
+other hand, no imaging libraries or complex computations are needed to
+generate and check CAPTCHAs.
Reply to: