Test your SYNOPSIS code

Test::Synopsis is an (author) test module to find .pm or .pod files under
your _lib_ directory and then make sure the example snippet code in your
_SYNOPSIS_ section passes the perl compile check.

Note that this module only checks the perl syntax (by wrapping the code
with 'sub') and doesn't actually run the code.

Suppose you have the following POD in your module.

=head1 NAME

Awesome::Template - My awesome template

=head1 SYNOPSIS

use Awesome::Template;

my $template = Awesome::Template->new;
$tempalte->render("template.at");

=head1 DESCRIPTION

An user of your module would try copy-paste this synopsis code and find
that this code doesn't compile because there's a typo in your variable name
_$tempalte_. Test::Synopsis will catch that error before you ship it.

Refresh
Refresh
Source Files
Filename Size Changed
Test-Synopsis-0.15.tar.gz 0000025127 24.5 KB over 4 years
cpanspec.yml 0000000669 669 Bytes almost 5 years
perl-Test-Synopsis.changes 0000003076 3 KB over 4 years
perl-Test-Synopsis.spec 0000002656 2.59 KB over 4 years
Comments for perl-Test-Synopsis 0