I have beef with some pod on cpan. I've been really hurting using some modules off and on because of horrible documentation. Not so much because of poor examples, but because of 'no' examples- or .. just a lot of stuff missing.

I've felt like sending a please please or a note.. But then I realize, these monkeys are just like me- they're busy as all hell- and I should be glad they put something out there and documented it. So the rare time I do ask or suggest- I do it with the most care and respect possible (it's appreciated)- Other then that- The solution is to write pod yourself!!!

I don't mean to come accross pushy- What I am thinking of is write an addon tutorial to some module you think is poorly documented. I sure should put the keyboard where my mouth is and do that myself. Thanks for bringing all this up.

In reply to Re: Campaign to clean up CPAN modules' POD? by leocharre
in thread Campaign to clean up CPAN modules' POD? by cLive ;-)

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.