Stories
Slash Boxes
Comments
NOTE: use Perl; is on undef hiatus. You can read content, but you can't post it. More info will be forthcoming forthcomingly.

All the Perl that's Practical to Extract and Report

use Perl Log In

Log In

[ Create a new account ]

drhyde (1683)

drhyde
  (email not shown publicly)
http://www.cantrell.org.uk/david

Journal of drhyde (1683)

Friday July 01, 2005
03:32 AM

AnnoCPAN

[ #25460 ]
I saw AnnoCPAN mentioned on the perl.it "blog". It looks interesting. But the people submitting comments to it would do better to submit documentation patches to the module authors.

As an example, this comment is very useful, but really, it should be in the POD so that it is installed on my machine for me to look at without having to dick around with tha intarweb.

The Fine Print: The following comments are owned by whoever posted them. We are not responsible for them in any way.
 Full
 Abbreviated
 Hidden
More | Login | Reply
Loading... please wait.
  • I think the point of AnnoCPAN is to make it _so_easy_ and low-key to add comments to the documentation that people will, y'know, actually do it. And then the module author can harvest the comments in one sweep and adjust the POD.

    Do you think the comments given so far would have been submitted as doc patches? How much trouble is it for anyone who never did that before to submit a doc patch? My guess: so much trouble that it won't happen.

    You don't change the behaviour of many people by making it difficult f
    • Submitting docpatches isn't hard. I know, cos I've done it. It's a mere matter of looking for the author's email address in the POD and suggesting a change. You don't need to send a diff or anything. It's far easier than finding the web site, searching for the module, trying to log in, forgetting your password, and so on. I'm all for making it easy. Which is why I'm all for people emailing docpatches.

      I wouldn't know AnnoCPAN existed unless I read the Italian Perl Mongers' blog, and how many module a