NAME
Test::Pod::Spelling::CommonMistakes - Checks POD for common spelling mistakes
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 than 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
SUPPORT
You can find documentation for this module with the perldoc command.
perldoc Test::Pod::Spelling::CommonMistakes
Websites
Search CPAN
http://search.cpan.org/dist/Test-Pod-Spelling-CommonMistakes
AnnoCPAN: Annotated CPAN documentation
CPAN Ratings
http://cpanratings.perl.org/d/Test-Pod-Spelling-CommonMistakes
CPAN Forum
RT: CPAN's Request Tracker
http://rt.cpan.org/NoAuth/Bugs.html?Dist=Test-Pod-Spelling-CommonMistakes
CPANTS Kwalitee
http://cpants.perl.org/dist/overview/Test-Pod-Spelling-CommonMistakes
CPAN Testers Results
http://cpantesters.org/distro/T/Test-Pod-Spelling-CommonMistakes.html
CPAN Testers Matrix
http://matrix.cpantesters.org/?dist=Test-Pod-Spelling-CommonMistakes
Git Source Code Repository
http://github.com/apocalypse/perl-test-pod-spelling-commonmistakes
Bugs
Please report any bugs or feature requests 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-CommonMistakes. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.
AUTHOR
Apocalypse <apocal@cpan.org>
COPYRIGHT AND LICENSE
Copyright 2010 by Apocalypse
This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
The full text of the license can be found in the LICENSE file included with this module.