Name : perl-Test-Synopsis
| |
Version : 0.17
| Vendor : openSUSE
|
Release : bp156.2.1
| Date : 2023-07-22 11:25:55
|
Group : Unspecified
| Source RPM : perl-Test-Synopsis-0.17-bp156.2.1.src.rpm
|
Size : 0.04 MB
| |
Packager : https://bugs_opensuse_org
| |
Summary : Test your SYNOPSIS code
|
Description :
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.
|
RPM found in directory: /vol/rzm3/linux-opensuse/distribution/leap/15.6/repo/oss/noarch |