I view CPAN as being like a box of mixed chocolates...

The argument you're making is equally valid for other aspects of code quality. There are CPAN modules without adequate test packages, modules that have unnecessary version dependencies, and (of course) modules with bugs in them. And, as you say, there are modules that aren't documented well (or at all).

One might as well say that nothing should get into CPAN without a test suite that can be shown to have 100% coverage, or until after an explicit peer review.

On the other hand, no one is forcing you to use CPAN modules, and you still might get usable code or at least ideas from the submissions.

There is a self-serving reason for CPAN authors to write documentation, of course; if you have a popular module, you'll get a lot less email to deal with if you add documentation. My own modules are pretty well documented (Archive::Zip: 27% pod, Algorithm::Diff: 54% pod) but I still get questions asking me about various things. I try to address these questions in the next version of the documentation so that I don't have to answer the same emails again.

Then too, just because you have documentation in a module doesn't mean that people will read it (as evidenced by the number of answers here on PM that quote one bit or another from the manual).


In reply to Re3: CPAN documentation improvements by bikeNomad
in thread CPAN documentation improvements by InfiniteSilence

Title:
Use:  <p> text here (a paragraph) </p>
and:  <code> code here </code>
to format your post, it's "PerlMonks-approved HTML":



  • Posts are HTML formatted. Put <p> </p> tags around your paragraphs. Put <code> </code> tags around your code and data!
  • Titles consisting of a single word are discouraged, and in most cases are disallowed outright.
  • Read Where should I post X? if you're not absolutely sure you're posting in the right place.
  • Please read these before you post! —
  • Posts may use any of the Perl Monks Approved HTML tags:
    a, abbr, b, big, blockquote, br, caption, center, col, colgroup, dd, del, details, div, dl, dt, em, font, h1, h2, h3, h4, h5, h6, hr, i, ins, li, ol, p, pre, readmore, small, span, spoiler, strike, strong, sub, summary, sup, table, tbody, td, tfoot, th, thead, tr, tt, u, ul, wbr
  • You may need to use entities for some characters, as follows. (Exception: Within code tags, you can put the characters literally.)
            For:     Use:
    & &amp;
    < &lt;
    > &gt;
    [ &#91;
    ] &#93;
  • Link using PerlMonks shortcuts! What shortcuts can I use for linking?
  • See Writeup Formatting Tips and other pages linked from there for more info.