Skip Menu |

This queue is for tickets about the WWW-Curl CPAN distribution.

Report information
The Basics
Id: 17854
Status: resolved
Priority: 0/
Queue: WWW-Curl

People
Owner: Nobody in particular
Requestors: christopher [...] pobox.com
Cc:
AdminCc:

Bug Information
Severity: Important
Broken in: 3.02
Fixed in: (no value)



Subject: Unuseable module due to complete lack of documentation
Just a suggestion - but - Either you should rename WWW::Curl::Easy to WWW::Curl::Difficult, or, have some empathy for the masses who you've mislead with the word "Easy" and actually put some documentation into this module so we can actually use it *Easily*
CC: christopher [...] pobox.com
Subject: Re: [rt.cpan.org #17854] Unuseable module due to complete lack of documentation
Date: Fri, 10 Mar 2006 06:32:58 +1100
To: bug-WWW-Curl [...] rt.cpan.org
From: Cris Bailiff <c.bailiff [...] awayweb.com>
Christopher, The name 'easy' is nothing to do with the perl module - it is the name used by the curl library interface for all its functions (originally, I beleive there was going to be a 'difficult' interface as well, for advanced users..) This module is a very thin wrapper around the functions provided by the curl library, so the perl documentation shows only only how to 'convert' from the native 'C' language interface to libcurl to this perl wrapper. You need to read the libcurl documentation to find out how to use the library. (There is a lot of curl/libcurl documentation, and there's no way I can keep up with (re-)documenting all the libcurl features and functions - Daniel does a great job with that already.) Perl users who have got to the point of looking to use libcurl for URL handling usually have a good idea of what they are trying to achieve, and more importantly, what libwww-perl doesn't do for them, so teaching the basics of URL fetching would be pretty redundant, although there are plenty of examples in the t/ directory... Cheers, Cris Quoting Guest via RT <bug-WWW-Curl@rt.cpan.org>: Show quoted text
> > Sat Feb 25 01:42:09 2006: Request 17854 was acted upon. > Transaction: Ticket created by guest > Queue: WWW-Curl > Subject: Unuseable module due to complete lack of documentation > Owner: Nobody > Requestors: christopher@pobox.com > Status: new > Ticket <URL: http://rt.cpan.org/Ticket/Display.html?id=17854 > > > > Just a suggestion - but - Either you should rename WWW::Curl::Easy to > WWW::Curl::Difficult, or, have some empathy for the masses who you've > mislead with the word "Easy" and actually put some documentation into > this module so we can actually use it *Easily* >