logo
Free, unlimited AI code reviews that run on commit
git-lrc git-lrc GitHub Install Now We'd appreciate a star git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt

Dist::Zilla::Plugin::PodCoverageTests - a author test for Pod coverage

Author

       Ricardo SIGNES 😏 <cpan@semiotic.systems>

Description

       This is an extension of Dist::Zilla::Plugin::InlineFiles, providing the following files:

         xt/author/pod-coverage.t - a standard Test::Pod::Coverage test

       This test uses Pod::Coverage::TrustPod to check your Pod coverage.  This means that to indicate that some
       subs should be treated as covered, even if no documentation can be found, you can add:

         =for Pod::Coverage sub_name other_sub this_one_too

       Test::Pod::Coverage 1.08 and Pod::Coverage::TrustPod will be added as "develop requires" dependencies.

       One can run the release tests by invoking "dzil test --release".

Name

       Dist::Zilla::Plugin::PodCoverageTests - a author test for Pod coverage

Perl Version

       This module should work on any version of perl still receiving updates from the Perl 5 Porters.  This
       means it should work on any version of perl released in the last two to three years.  (That is, if the
       most recently released version is v5.40, then this module should work on both v5.40 and v5.38.)

       Although it may work on older versions of perl, no guarantee is made that the minimum required version
       will not be increased.  The version may be increased for any reason, and there is no promise that patches
       will be accepted to lower the minimum required perl.

Synopsis

           # Add this line to dist.ini
           [PodCoverageTests]

           # Run this in the command line to test for POD coverage:
           $ dzil test --release

Version

       version 6.032

See Also