.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Perl::Critic::Policy::Documentation::PodSpelling 3pm"
.TH Perl::Critic::Policy::Documentation::PodSpelling 3pm 2023-07-26 "perl v5.38.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
Perl::Critic::Policy::Documentation::PodSpelling \- Check your spelling.
.SH AFFILIATION
.IX Header "AFFILIATION"
This Policy is part of the core Perl::Critic
distribution.
.SH DESCRIPTION
.IX Header "DESCRIPTION"
Did you write the documentation?  Check.
.PP
Did you document all of the public methods?  Check.
.PP
Is your documentation readable?  Hmm...
.PP
Ideally, we'd like Perl::Critic to tell you when your documentation is
inadequate.  That's hard to code, though.  So, inspired by
Test::Spelling, this module checks the spelling of
your POD.  It does this by pulling the prose out of the code and
passing it to an external spell checker.  It skips over words you
flagged to ignore.  If the spell checker returns any misspelled words,
this policy emits a violation.
.PP
If anything else goes wrong \-\- we can't locate the spell checking program or
(gasp!) your module has no POD \-\- then this policy passes.
.PP
To add exceptions on a module-by-module basis, add "stopwords" as
described in Pod::Spell.  For example:
.PP
.Vb 1
\&    =for stopwords gibbles
\&
\&    =head1 Gibble::Manip \-\- manipulate your gibbles
\&
\&    =cut
.Ve
.SH CONFIGURATION
.IX Header "CONFIGURATION"
This policy can be configured to tell which spell checker to use or to
set a global list of spelling exceptions.  To do this, put entries in
a \fI.perlcriticrc\fR file like this:
.PP
.Vb 4
\&    [Documentation::PodSpelling]
\&    spell_command = aspell list
\&    stop_words = gibbles foobar
\&    stop_words_file = some/path/with/stop/words.txt
.Ve
.PP
The default spell command is \f(CW\*(C`aspell list\*(C'\fR and it is interpreted as a
shell command.  We parse the individual arguments via
Text::ParseWords so feel free to use quotes around
your arguments.  If the executable path is an absolute file name, it
is used as-is.  If it is a relative file name, we employ
File::Which to convert it to an absolute path via the
\&\f(CW\*(C`PATH\*(C'\fR environment variable.  As described in Pod::Spell and
Test::Spelling, the spell checker must accept text on STDIN and print
misspelled words one per line on STDOUT.
.PP
You can specify global stop words via the \f(CW\*(C`stop_words\*(C'\fR and
\&\f(CW\*(C`stop_words_file\*(C'\fR options.  The former is simply split up on
whitespace.  The latter is looked at line by line, with anything after
an octothorp ("#") removed and then leading and trailing whitespace
removed.  Silly example valid file contents:
.PP
.Vb 1
\&    # It\*(Aqs a comment!
\&
\&    foo
\&    arglbargl    # Some other comment.
\&    bar
.Ve
.PP
The values from \f(CW\*(C`stop_words\*(C'\fR and \f(CW\*(C`stop_words_file\*(C'\fR are merged
together into a single list of exemptions.
.SH NOTES
.IX Header "NOTES"
A spell checking program is not included with Perl::Critic.
.PP
The results of failures for this policy can be confusing when \fIaspell\fR
complains about words containing punctuation such as hyphens and apostrophes.
In this situation \fIaspell\fR will often only emit part of the word that it
thinks is misspelled.  For example, if you ask \fIaspell\fR to check
"foobie-bletch", the output only complains about "foobie".  Unfortunately,
you'll have to look through your POD to figure out what the real word that
\&\fIaspell\fR is complaining about is.  One thing to try is looking at the output
of \f(CW\*(C`perl \-MPod::Spell \-e \*(Aqprint
Pod::Spell\->new()\->parse_from_file("lib/Your/Module.pm")\*(Aq\*(C'\fR to see what is
actually being checked for spelling.
.SH PREREQUISITES
.IX Header "PREREQUISITES"
This policy will disable itself if File::Which is not
available.
.SH CREDITS
.IX Header "CREDITS"
Initial development of this policy was supported by a grant from the
Perl Foundation.
.SH AUTHOR
.IX Header "AUTHOR"
Chris Dolan <cdolan@cpan.org>
.SH COPYRIGHT
.IX Header "COPYRIGHT"
Copyright (c) 2007\-2021 Chris Dolan.  Many rights reserved.
.PP
This program is free software; you can redistribute it and/or modify
it under the same terms as Perl itself.  The full text of this license
can be found in the LICENSE file included with this module