Beefy Boxes and Bandwidth Generously Provided by pair Networks
Just another Perl shrine
 
PerlMonks  

Comment on

( #3333=superdoc: print w/replies, xml ) Need Help??
The problem won't go away if we use XML over POD. Both formats are display orientated, not data oriented. XML doesn't have to be, but in this context it is. There are other ways to do do this. We, the community, could impose a standard, which won't work. We could also build on the POD test suites.

I actually discovered these last weekend after using Module::Starter::PBP for the fist time. All the sudden I had 14 failues. Once I figured out that there were POD test suites in there, I got the motivation to finish up my documentation.

Test driven development works for developers because we can see what we have accomplished, and what we have left to do. In fact tests help us remember that we're not done yet. The same works for a certain class of POD, too. Why not extend it?

Cheers,

John


In reply to Re: Please for the love of god, can I get a documentation format that doesn't suck? by raptnor2
in thread Please for the love of god, can I get a documentation format that doesn't suck? by BUU

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, 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
  • 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.
  • Log In?
    Username:
    Password:

    What's my password?
    Create A New User
    Chatterbox?
    [prathap keerthipati]: how to update perl in unix
    [hippo]: yum update perl
    [hippo]: Other package managers are available
    LanX wouldn't update system Perl!
    [Discipulus]: prathap keerthipati might be it is better to install an alternative Perl instead and do not touch the system one
    [LanX]: see perlbrew for alternative Perl installations
    [marto]: unless you know exactly what you're doing an often saner option is to simply build another Perl rather than replace the system one

    How do I use this? | Other CB clients
    Other Users?
    Others lurking in the Monastery: (16)
    As of 2017-03-23 10:36 GMT
    Sections?
    Information?
    Find Nodes?
    Leftovers?
      Voting Booth?
      Should Pluto Get Its Planethood Back?



      Results (285 votes). Check out past polls.