perl-Test-Synopsis

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, UNLESS that code is a
'BEGIN {}' block or a 'use' statement.
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.

          

---

License: Artistic-1.0 OR GPL-1.0-or-later
URL: https://metacpan.org/release/Test-Synopsis