Dependency of nagios-plugins-nwc-health-8.0-1.1.src.rpm

Name: perl-Test-Spelling

Project: openSUSE_13.2

Repository: oss

Title: check for spelling errors in POD files

Description:
'Test::Spelling' lets you check the spelling of a POD file, and report its
results in standard 'Test::More' fashion. This module requires a spellcheck
program such as _spell_, _aspell_, _ispell_, or _hunspell_.

use Test::Spelling;
pod_file_spelling_ok('lib/Foo/Bar.pm', 'POD file spelling OK');

Note that it is a bad idea to run spelling tests during an ordinary CPAN
distribution install, or in a package that will run in an uncontrolled
environment. There is no way of predicting whether the word list or
spellcheck program used will give the same results. You *can* include the
test in your distribution, but be sure to run it only for authors of the
module by guarding it in a 'skip_all unless -d 'inc/.author'' clause, or by
putting the test in your distribution's _xt/_ directory. Anyway, people
installing your module really do not need to run such tests, as it is
unlikely that the documentation will acquire typos while in transit. :-)

You can add your own stop words, which are words that should be ignored by
the spell check, like so:

add_stopwords(qw(asdf thiswordiscorrect));

Adding stop words in this fashion affects all files checked for the
remainder of the test script. See the Pod::Spell manpage (which this module
is built upon) for a variety of ways to add per-file stop words to each .pm
file.

If you have a lot of stop words, it's useful to put them in your test
file's 'DATA' section like so:

use Test::Spelling;
add_stopwords(<DATA>);
all_pod_files_spelling_ok();

__END__
folksonomy
Jifty
Zakirov

To maintain backwards compatibility, comment markers and some whitespace
are ignored. In the near future, the preprocessing we do on the arguments
to the add_stopwords manpage will be changed and documented properly.

Version: 0.19

Release: 4.1.3

Architecture: noarch

Size: 18.8 KB

Build Time: 2014-10-06 18:25:26 +0200 (over 9 years ago)