use Perl

• Easier is different, too (Score:1)

  by jplindstrom (594)

  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
  • Re:Easier is different, too (Score:2)

    by drhyde (1683)

    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
    • Re:Easier is different, too (Score:1)

      by sigzero (5768)

      Pointless? Seems to work for the PHP really well.
      • REALLY well (Score:1)

        by davebaker (4482)

        I agree!
    • Re:Easier is different, too (Score:1)

      by itub (5708)

      Who knows, only history will tell if it is really useful or not. I believe it will, and that's why I worked on it.

      AnnoCPAN was officially announced to the world two days ago, so the fact that you already heard about it is actually a good sign. ;-)

      The main reason I think it can work better than sending an email to the author of a module is because it provides instant gratification--you add a note, and there it is. If you send an email to the author, assuming that he reads his CPAN email, likes your sugg
      • Re:Easier is different, too (Score:2)

        by autarch (914)

        RSS by author would be great. I definitely want to track annotations on my modules, but it's got to be convenient.
        • Re:Easier is different, too (Score:1)

          by itub (5708)

          Done. See http://annocpan.org/~drolsky/recent.rss [annocpan.org] , for example.
          • Re:Easier is different, too (Score:2)

            by autarch (914)

            Wow, now that's service.
            
            Ok, now how about some house-cleaning, cooking me some gourmet vegan meals, and ...
      • Re:Easier is different, too (Score:2)

        by drhyde (1683)

        I would love to get email notifications - I get them already when people report bugs using rt.cpan, and I didn't ask for that. Such emails wouldn't normally be classed as spam if that's what you're worried about - spam is defined as being unsolicited bulk email, and this wouldn't be bulk.

        An alternative would be for you to automagically populate RT with these suggested documentation updates.