Beefy Boxes and Bandwidth Generously Provided by pair Networks
Your skill will accomplish
what the force of many cannot
 
PerlMonks  

comment on

( [id://3333]=superdoc: print w/replies, xml ) Need Help??

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":



  • Are you posting in the right place? Check out Where do I post X? to know for sure.
  • Posts may use any of the Perl Monks Approved HTML tags. Currently these include the following:
    <code> <a> <b> <big> <blockquote> <br /> <dd> <dl> <dt> <em> <font> <h1> <h2> <h3> <h4> <h5> <h6> <hr /> <i> <li> <nbsp> <ol> <p> <small> <strike> <strong> <sub> <sup> <table> <td> <th> <tr> <tt> <u> <ul>
  • Snippets of code should be wrapped in <code> tags not <pre> tags. In fact, <pre> tags should generally be avoided. If they must be used, extreme care should be taken to ensure that their contents do not have long lines (<70 chars), in order to prevent horizontal scrolling (and possible janitor intervention).
  • Want more info? How to link or How to display code and escape characters are good places to start.
Log In?
Username:
Password:

What's my password?
Create A New User
Domain Nodelet?
Chatterbox?
and the web crawler heard nothing...

How do I use this?Last hourOther CB clients
Other Users?
Others examining the Monastery: (3)
As of 2024-04-26 05:11 GMT
Sections?
Information?
Find Nodes?
Leftovers?
    Voting Booth?

    No recent polls found