Join GitHub today
GitHub is home to over 20 million developers working together to host and review code, manage projects, and build software together.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
|Failed to load latest commit information.|
NAME Dist::Zilla::Plugin::PodSpellingTests - Release tests for POD spelling VERSION version 1.111520 SYNOPSIS In "dist.ini": [PodSpellingTests] or: [PodSpellingTests] wordlist = Pod::Wordlist spell_cmd = aspell list stopwords = CPAN stopwords = github stopwords = stopwords stopwords = wordlist or, if you wanted to use my plugin bundle but just override this plugin's configuration: [@Filter] -bundle = @MARCEL -remove = PodSpellingTests [PodSpellingTests] wordlist = Pod::Wordlist spell_cmd = aspell list stopwords = CPAN stopwords = github stopwords = stopwords stopwords = wordlist DESCRIPTION This is an extension of Dist::Zilla::Plugin::InlineFiles, providing the following file: xt/release/pod-spell.t - a standard Test::Spelling test METHODS wordlist The module name of a word list you wish to use that works with Test::Spelling. Defaults to Pod::Wordlist::hanekomu. spell_cmd If "spell_cmd" is set then "set_spell_cmd( your_spell_command );" is added to the test file to allow for custom spell check programs. Defaults to nothing. stopwords If stopwords is set then "add_stopwords( <DATA> )" is added to the test file and the words are added after the "__DATA__" section. "stopwords" can appear multiple times, one word per line. Normally no stopwords are added by default, but author names appearing in "dist.ini" are automatically added as stopwords so you don't have to add them manually just because they might appear in the "AUTHORS" section of the generated POD document. INSTALLATION See perlmodinstall for information and options on installing Perl modules. BUGS AND LIMITATIONS No bugs have been reported. Please report any bugs or feature requests through the web interface at <http://rt.cpan.org/Public/Dist/Display.html?Name=Dist-Zilla-Plugin-PodS pellingTests>. AVAILABILITY The latest version of this module is available from the Comprehensive Perl Archive Network (CPAN). Visit <http://www.perl.com/CPAN/> to find a CPAN site near you, or see <http://search.cpan.org/dist/Dist-Zilla-Plugin-PodSpellingTests/>. The development version lives at <http://github.com/hanekomu/Dist-Zilla-Plugin-PodSpellingTests> and may be cloned from <git://github.com/hanekomu/Dist-Zilla-Plugin-PodSpellingTests.git>. Instead of sending patches, please fork this project using the standard git and github infrastructure. AUTHORS * Marcel Gruenauer <firstname.lastname@example.org> * Harley Pig <email@example.com> COPYRIGHT AND LICENSE This software is copyright (c) 2010 by Marcel Gruenauer. This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.