Stories
Slash Boxes
Comments
NOTE: use Perl; is on undef hiatus. You can read content, but you can't post it. More info will be forthcoming forthcomingly.

All the Perl that's Practical to Extract and Report

The Fine Print: The following comments are owned by whoever posted them. We are not responsible for them in any way.
 Full
 Abbreviated
 Hidden
More | Login | Reply
Loading... please wait.
  • Any thoughts on how you would support "optional", development support testing modules?

    For example, in the documentation for Test::Pod::Coverage, it recommends putting the module requirements behind an eval and skip_all statement, so that you, as the developer, can ensure that your POD is covered, but the end user doesn't need to have the testing modules installed.

    While I, as a developer may care that the documentation is complete, I, as an end user, do not.

    There might be a better example than what I provided, but I think the idea is at least laid out.

    --MLX

    • The best method is to also put it behind a RELEASE_TESTING (or at the least AUTOMATED_TESTING) environment check.

      Here's the pod check test that I use, which as far as I'm aware encapsulates the current best practice.

      #!/usr/bin/perl

      # Test that the syntax of our POD documentation is valid

      use strict;
      BEGIN {
              $| = 1;
              $^W = 1;
      }

      my @MODULES = (
              'Pod::Simple 3.07',
              'Test::Pod 1.26',
      );

      # Don't run tests for

      • Really? I would just use Module::Install::AuthorTests [cpan.org]. A suggestion: How about a Makefile.PL directive which causes Module::Install to do a requires_from on all .pm files in lib/, and perhaps a test_requires_from on all .t files in t/ ?