On Thu, Apr 18, 2002 at 08:38:21PM +0200, Andreas Marcel Riechert wrote:
> Michael G Schwern <[EMAIL PROTECTED]> writes:
>  
> > Since mixin is so experimental, let's use a more concrete and complete
> > example.  Exporter::Lite.
> 
> In the very special case of Exporter::Lite even putting all the
> SYNOPSIS and Description stuff from Lite.pm into the README file 
> would have been a pretty good idea, because
> 
>   http://search.cpan.org/search?mode=module&query=Exporter%3A%3ALite
> 
> isn't of any help in this case

That's search.cpan.org's problem.  I have confidence that it'll get fixed.


> and doing more than one "cd" to find some Documentation (=Module) is
> a kind of annoying for a lazzy person like me.

For some reason I'm having trouble sympathizing. ;)


> But, Exporter::Lite is a very special case.

Exporter::Lite is a good illustration of how I normally write my
modules and documentation.  Fairly small, fairly single purpose.
It's not a special case.

A case where extra information would have to be in a README might be
the Test-Simple package which contains more than one logical module.
It would explain that there's Test::Simple, Test::More, Test::Builder
and Test::Tutorial.


If someone would pick up mod2readme and finish it off then I'll gladly
use it and generate README files.


-- 

Michael G. Schwern   <[EMAIL PROTECTED]>    http://www.pobox.com/~schwern/
Perl Quality Assurance      <[EMAIL PROTECTED]>         Kwalitee Is Job One
List context isn't dangerous.  Misquoting Gibson is dangerous.
        -- Ziggy

Reply via email to