Beefy Boxes and Bandwidth Generously Provided by pair Networks
Perl-Sensitive Sunglasses
 
PerlMonks  

Comment on

( #3333=superdoc: print w/ replies, xml ) Need Help??

Your wrapper most likely contains perl based functions, right? Does each and every one of these perl functions do the same thing as their BLAST equivalents? If they don't, I would write a short blurb about the functions. You don't need to be extremely verbose, just saying "foo($bar) is the same as the bass equivalent of foo(int bar), and the return value will always be a hash instead of the bass char[2][256]" So, if everything is exactly the same I see no problems with referring people to other documentation. But if it isn't, be sure to document the changes, so people don't have to screw with them to figure out how they work.

CGI.pm is a good example of how you don't always have to document all of your features for the documentation to be successful. For instance, CGI.pm uses function which are named after their corresponding HTML tags. So, the POD has a section where it explains that if it's available in HTML, it's a function spelled with lowercase letters. IMHO, this makes the documentation much more concise because it doesn't have a list of functions which all do the same thing, and is a great way to go.


Want to support the EFF and FSF by buying cool stuff? Click here.

In reply to Re: On providing documentation with your modules by Vautrin
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 rifling through the Monastery: (10)
    As of 2014-09-30 13:31 GMT
    Sections?
    Information?
    Find Nodes?
    Leftovers?
      Voting Booth?

      How do you remember the number of days in each month?











      Results (370 votes), past polls