perl-Test-Spelling - Check for spelling errors in POD files

Property Value
Distribution openSUSE Tumbleweed
Repository openSUSE Oss all
Package filename perl-Test-Spelling-0.22-1.1.noarch.rpm
Package name perl-Test-Spelling
Package version 0.22
Package release 1.1
Package architecture noarch
Package type rpm
Category Development/Libraries/Perl
License Artistic-1.0 OR GPL-1.0-or-later
Maintainer -
Download size 29.90 KB
Installed size 44.23 KB
'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/', '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 Pod::Spell (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;
To maintain backwards compatibility, comment markers and some whitespace
are ignored. In the near future, the preprocessing we do on the arguments
to add_stopwords will be changed and documented properly.


Package Version Architecture Repository
perl-Test-Spelling - - -


Name Value
perl(:MODULE_COMPAT_5.28.1) -
perl(IPC::Run3) -
perl(Pod::Spell) -


Name Value
perl(Test::Spelling) = 0.22
perl-Test-Spelling = 0.22-1.1


Type URL
Binary Package perl-Test-Spelling-0.22-1.1.noarch.rpm
Source Package perl-Test-Spelling-0.22-1.1.src.rpm

Install Howto

Install perl-Test-Spelling rpm package:

# zypper install perl-Test-Spelling




2019-04-25 - Stephan Kulow <>
- updated to 0.22
see /usr/share/doc/packages/perl-Test-Spelling/Changes
0.22      2019-04-24
- Zero-code-change release encompassing everything from 0.21
- Resolves RT#120425 . in @INC should no longer be an issue
0.21      2019-04-19 (TRIAL)
- Removed the POD spelling test from /t as it's now in /xt
- Forego usage of inc::Module::Install for EU::MM
- List out all prereqs individually; provide cpanfile
- Use dzil to build the dist
- Convert the README to markdown
- Add a LICENSE file
- Clean up the Changes log
2017-10-03 -
- patch the Makefile to build with perl 5.26
2015-02-07 -
- updated to 0.20
- Add a sorted list of your most commonly misspelled words to
the end of all_pod_files_spelling_ok to aid stopword list creation
and bulk correction. (Kent Fredric)
2013-06-04 -
- updated to 0.19
- for more consistent results avoid using the user's local aspell
dictionary [ #56483] (Karen Etheridge)
- Work around Pod::Spell limitations (David Golden)
- Improve case handling (David Golden)
- Improve test failure reporting (Karen Etheridge)
- Include more useful info in Test-Spelling's own test
suite (Shawn Moore)
- Use IPC::Run3 instead of IPC::Open3
Quoth IPC::Open3:
If you try to read from the child's stdout writer
and their stderr writer, you'll have problems with
blocking ... This is very dangerous, as you may
block forever.
Also the code is nicely shorter. (Randy Stauner)
- Allow use of a custom POD parser rather than Pod::Spell
using set_pod_parser (Thomas Sibley)
2011-12-19 -
- update to 0.15
- Begin adding actual tests
(Hilariously, adding the suggested t/pod-spell.t to this
dist to test itself found a typo: "stopwards")
- Fix an error when using add_stopwords("constant", "strings")
[ #68471] (reported by Nicholas Bamber)
- Make alternatives checking more robust by reading the spellchecker's
- Best Practical has taken over maintainership of this module
- Try various spellcheck programs instead of hardcoding the ancient
`spell` [ #56483] (reported by Lars D??????, et al)
- Remove temporary files more aggressively [ #41586]
(reported by Tokuhiro Matsuno)
- fixed by not creating them at all :) instead we now use IPC::Open3
- Remove suggestion to use broken `aspell -l` [ #28967]
(reported by David Hand)
- Add set_pod_file_filter for skipping translations, etc.
- Skip tests in all_pod_files_spelling_ok if there is no working
- Provide a has_working_spellchecker so you can skip your own tests if
there's no working spellchecker
- Switch to Module::Install
- Rewrite and modernize a lot of the documentation
- Decruftify code, such as by using Exporter and lexical filehandles
- Support .plx files (you're welcome Schwern)
2010-12-01 -
- switch to perl_requires macro
2010-11-29 -
- remove /var/adm/perl-modules
2010-08-27 -
- initial package (0.11)

See Also

Package Description
perl-Test-Strict-0.47-1.2.noarch.rpm Check syntax, presence of use strict; and test coverage
perl-Test-SubCalls-1.10-1.3.noarch.rpm Track the number of times subs are called
perl-Test-Synopsis-0.15-1.6.noarch.rpm Test your SYNOPSIS code
perl-Test-TCP-2.19-1.5.noarch.rpm Testing Tcp Program
perl-Test-Taint-1.06-6.3.i586.rpm Tools to test taintedness
perl-Test-Taint-1.06-6.3.x86_64.rpm Tools to test taintedness
perl-Test-TempDir-Tiny-0.018-1.3.noarch.rpm Temporary directories that stick around when tests fail
perl-Test-Time-0.05-1.4.noarch.rpm Overrides the time() and sleep() core functions for testing
perl-Test-Trap-0.3.4-1.3.noarch.rpm Trap exit codes, exceptions, output, etc
perl-Test-Unit-0.25-10.11.noarch.rpm The PerlUnit testing framework
perl-Test-Unit-Lite-0.1202-5.9.noarch.rpm Unit testing without external dependencies
perl-Test-UseAllModules-0.17-1.9.noarch.rpm do use_ok() for all the MANIFESTed modules
perl-Test-WWW-Mechanize-1.52-1.3.noarch.rpm Testing-specific WWW::Mechanize subclass
perl-Test-WWW-Selenium-1.36-3.11.noarch.rpm Test applications using Selenium Remote Control
perl-Test-Warn-0.36-1.2.noarch.rpm Perl extension to test methods for warnings