Beefy Boxes and Bandwidth Generously Provided by pair Networks
Clear questions and runnable code
get the best and fastest answer
 
PerlMonks  

Comment on

( #3333=superdoc: print w/ replies, xml ) Need Help??
I've seen a lot of XS modules that skimped on docs because they thought they could, when in reality, the syntax can and might be different. Try googling for info on OpenGL.pm and you won't find much, and the POD doesn't help either... so where, oh where, is that canonical spinning Gouraud shaded cube in Perl? I certaintly can't find it. So, even to this day, I haven't used OpenGL.pm

Bottom line, documentation is great stuff, and if you can take an extra 30 minutes and include a simple example with that XS module, I'll thank you for it! :)

Even if you're own module is not XS-only, and you just have an API, a few lines of code using that API is always useful as well. Another bad habit I've seen is CPAN pages that say "for documentation visit http://xxx.yyy.zz, which is a problem because then your handy perldoc in an xterm is suddenly no good.


In reply to Re: On providing documentation with your modules by flyingmoose
in thread On providing documentation with your modules by Jouke

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!
  • 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, 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, sup, table, tbody, td, tfoot, th, thead, tr, tt, u, ul, wbr
  • Outside of code tags, you may need to use entities for some characters:
            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.
  • Log In?
    Username:
    Password:

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

    How do I use this? | Other CB clients
    Other Users?
    Others studying the Monastery: (8)
    As of 2014-11-27 04:44 GMT
    Sections?
    Information?
    Find Nodes?
    Leftovers?
      Voting Booth?

      My preferred Perl binaries come from:














      Results (179 votes), past polls