NAME
Test::Pod::Spelling::CommonMistakes - Checks POD for common spelling
mistakes
VERSION
This document describes v1.000 of Test::Pod::Spelling::CommonMistakes - released February 21, 2011 as part of Test-Pod-Spelling-CommonMistakes.
SYNOPSIS
#!/usr/bin/perl
use strict; use warnings;
use Test::More;
eval "use Test::Pod::Spelling::CommonMistakes";
if ( $@ ) {
plan skip_all => 'Test::Pod::Spelling::CommonMistakes required for testing POD';
} else {
all_pod_files_ok();
}
DESCRIPTION
This module checks your POD for common spelling errors. This differs
from Test::Spelling because it doesn't use your system spellchecker and
instead uses Pod::Spell::CommonMistakes for the heavy lifting. Using it
is the same as any standard Test::* module, as seen here.
METHODS
all_pod_files_ok( [ @files ] )
This function is what you will usually run. It automatically finds any
POD in your distribution and runs checks on them.
Accepts an optional argument: an array of files to check. By default it
checks all POD files it can find in the distribution. Every file it
finds is passed to the "pod_file_ok()" function.
pod_file_ok( $file, [ $name ] )
"pod_file_ok()" will okay the test if there is spelling errors present
in the POD. Furthermore, if the POD was malformed as reported by
Pod::Simple, the test will fail and not attempt to check spelling.
When it fails, "pod_file_ok()" will show any misspelled words and their
suggested spelling as diagnostics.
The optional second argument $name is the name of the test. If it is
omitted, "pod_file_ok()" chooses a default test name "Spelling test for
$file".
EXPORT
Automatically exports the two subs.
SEE ALSO
Please see those modules/websites for more information related to this
module.
* Pod::Spell::CommonMistakes
SUPPORT
Perldoc
You can find documentation for this module with the perldoc command.
perldoc Test::Pod::Spelling::CommonMistakes
Websites
The following websites have more information about this module, and may
be of help to you. As always, in addition to those websites please use
your favorite search engine to discover more resources.
* Search CPAN
<http://search.cpan.org/dist/Test-Pod-Spelling-CommonMistakes>
* RT: CPAN's Bug Tracker
<http://rt.cpan.org/NoAuth/Bugs.html?Dist=Test-Pod-Spelling-CommonMi
stakes>
* AnnoCPAN: Annotated CPAN documentation
<http://annocpan.org/dist/Test-Pod-Spelling-CommonMistakes>
* CPAN Ratings
<http://cpanratings.perl.org/d/Test-Pod-Spelling-CommonMistakes>
* CPAN Forum
<http://cpanforum.com/dist/Test-Pod-Spelling-CommonMistakes>
* CPANTS Kwalitee
<http://cpants.perl.org/dist/overview/Test-Pod-Spelling-CommonMistak
es>
* CPAN Testers Results
<http://cpantesters.org/distro/T/Test-Pod-Spelling-CommonMistakes.ht
ml>
* CPAN Testers Matrix
<http://matrix.cpantesters.org/?dist=Test-Pod-Spelling-CommonMistake
s>
Email
You can email the author of this module at "APOCAL at cpan.org" asking
for help with any problems you have.
Internet Relay Chat
You can get live help by using IRC ( Internet Relay Chat ). If you don't
know what IRC is, please read this excellent guide:
<http://en.wikipedia.org/wiki/Internet_Relay_Chat>. Please be courteous
and patient when talking to us, as we might be busy or sleeping! You can
join those networks/channels and get help:
* irc.perl.org
You can connect to the server at 'irc.perl.org' and join this
channel: #perl-help then talk to this person for help: Apocalypse.
* irc.freenode.net
You can connect to the server at 'irc.freenode.net' and join this
channel: #perl then talk to this person for help: Apocal.
* irc.efnet.org
You can connect to the server at 'irc.efnet.org' and join this
channel: #perl then talk to this person for help: Ap0cal.
Bugs / Feature Requests
Please report any bugs or feature requests by email to
"bug-test-pod-spelling-commonmistakes at rt.cpan.org", or through the
web interface at
<http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Test-Pod-Spelling-Common
Mistakes>. You will be automatically notified of any progress on the
request by the system.
Source Code
The code is open to the world, and available for you to hack on. Please
feel free to browse it and play with it, or whatever. If you want to
contribute patches, please send me a diff or prod me to pull from your
repository :)
<http://github.com/apocalypse/perl-test-pod-spelling-commonmistakes>
git clone git://github.com/apocalypse/perl-test-pod-spelling-commonmistakes.git
AUTHOR
Apocalypse <APOCAL@cpan.org>
COPYRIGHT AND LICENSE
This software is copyright (c) 2011 by Apocalypse.
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.
The full text of the license can be found in the LICENSE file included
with this distribution.