/ 
Test-SpellCheck-0.02
/ Test::SpellCheck::Plugin::PerlPOD

NAME

Test::SpellCheck::Plugin::PerlPOD - Test::SpellCheck plugin for checking spelling in POD

VERSION

version 0.02

SYNOPSIS

# these are the default options
spell_check [PerlPOD, skip_sections => ['contributors', 'author', 'copyright and license']];

Or from spellcheck.ini:

[PerlPOD]
skip_sections = contributors
skip_sections = author
skip_sections = copyright and license

DESCRIPTION

This plugin adds checking of POD for spelling errors. It will also check for POD syntax errors.

OPTIONS

skip_sections

You can skip sections, which is typically useful for "author" or "copyright and license" sections, since these are often generated and contain a number of names.

CONSTRUCTOR

new

my $plugin = Test::SpellCheck::Plugin::PerlPOD->new(%options);

This creates a new instance of the plugin. Any of the options documented above can be passed into the constructor.

SEE ALSO

Test::SpellCheck
Test::SpellCheck::Plugin

AUTHOR

Graham Ollis <plicease@cpan.org>

COPYRIGHT AND LICENSE

This software is copyright (c) 2021-2024 by Graham Ollis.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.