It's increasingly common to see Pod coverage tests with Test::Pod::Coverage included with module distributions, thanks to the awareness (hype?) from automated CPANTS Kwalitee testing. Many distribution-building tools, like Module::Starter::PBP generate a pod-coverage.t like this:

use Test::More; eval "use Test::Pod::Coverage 1.04"; plan skip_all => "Test::Pod::Coverage 1.04 required for testing POD co +verage" if $@; all_pod_coverage_ok();

The danger here is that Test::Pod::Coverage doesn't require any particular underlying version of Pod::Coverage, so if you are using a recent version of Pod::Coverage, but are documenting in a style that isn't recognized under older versions, those installing your module with an out-of-date Pod::Coverage will mysteriously fail your pod-coverage.t test.

Documentation styles to watch out for, based on the bug in a prereq module that I recently encountered, are method-style documentation syntaxes with semicolons or parens on the end:

=head2 $self->foo(); =head2 $self->foo;

If you feel you must include a pod-coverage.t file with a distribution, I encourage you to check that your documentation syntax is backwards compatible, or else add an explicit check for the necessary version of Pod::Coverage.

-xdg

Code written by xdg and posted on PerlMonks is public domain. It is provided as is with no warranties, express or implied, of any kind. Posted code may not have been tested. Use of posted code is at your own risk.


In reply to Careful with Test::Pod::Coverage by xdg

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.