I'm generating pod in one of my projects.

The documentation for Module.pm is written into Module.pod and calling perldoc Module shows the generated content in Module.pod (see perldoc )³.

To keep it synchronized I've integrated the call to my podbuilder.pl script into my test suite as “pseudo test“.

Since I never release² without testing¹, my documentation is always up to date and if podbuilder.pl fails then my test suite fails too.

(actually I still have to teach git-commit to stop telling that Module.pod has changed, don't wanna be told anymore about the obvious ;)

Works for me! :)

HTH!

Cheers Rolf

(addicted to the Perl Programming Language and ☆☆☆☆ :)

¹) Using the modulino principle to run the test suite facilitate things a lot.

²) even hardly ever commit w/o testing...

³) perldoc Module.pm for my internal developer documentation


In reply to Re: Generated POD and CPAN/MetaCPAN by LanX
in thread Generated POD and CPAN/MetaCPAN by wanna_code_perl

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.