1Test::Pod::Spelling::CoUmsmeornMCiosnttarkiebsu(t3epdmT)Peesrtl::DPoocdu:m:eSnptealtliionng::CommonMistakes(3pm)
2
3
4
6 Test::Pod::Spelling::CommonMistakes - Checks POD for common spelling
7 mistakes
8
10 This document describes v1.001 of Test::Pod::Spelling::CommonMistakes - released October 31, 2014 as part of Test-Pod-Spelling-CommonMistakes.
11
13 #!/usr/bin/perl
14 use strict; use warnings;
15
16 use Test::More;
17
18 eval "use Test::Pod::Spelling::CommonMistakes";
19 if ( $@ ) {
20 plan skip_all => 'Test::Pod::Spelling::CommonMistakes required for testing POD';
21 } else {
22 all_pod_files_ok();
23 }
24
26 This module checks your POD for common spelling errors. This differs
27 from Test::Spelling because it doesn't use your system spellchecker and
28 instead uses Pod::Spell::CommonMistakes for the heavy lifting. Using it
29 is the same as any standard Test::* module, as seen here.
30
32 all_pod_files_ok( [ @files ] )
33 This function is what you will usually run. It automatically finds any
34 POD in your distribution and runs checks on them.
35
36 Accepts an optional argument: an array of files to check. By default it
37 checks all POD files it can find in the distribution. Every file it
38 finds is passed to the "pod_file_ok()" function.
39
40 pod_file_ok( $file, [ $name ] )
41 "pod_file_ok()" will okay the test if there is spelling errors present
42 in the POD. Furthermore, if the POD was malformed as reported by
43 Pod::Simple, the test will fail and not attempt to check spelling.
44
45 When it fails, "pod_file_ok()" will show any misspelled words and their
46 suggested spelling as diagnostics.
47
48 The optional second argument $name is the name of the test. If it is
49 omitted, "pod_file_ok()" chooses a default test name "Spelling test for
50 $file".
51
53 Automatically exports the two subs.
54
56 Please see those modules/websites for more information related to this
57 module.
58
59 • Pod::Spell::CommonMistakes
60
62 Perldoc
63 You can find documentation for this module with the perldoc command.
64
65 perldoc Test::Pod::Spelling::CommonMistakes
66
67 Websites
68 The following websites have more information about this module, and may
69 be of help to you. As always, in addition to those websites please use
70 your favorite search engine to discover more resources.
71
72 • MetaCPAN
73
74 A modern, open-source CPAN search engine, useful to view POD in
75 HTML format.
76
77 <http://metacpan.org/release/Test-Pod-Spelling-CommonMistakes>
78
79 • Search CPAN
80
81 The default CPAN search engine, useful to view POD in HTML format.
82
83 <http://search.cpan.org/dist/Test-Pod-Spelling-CommonMistakes>
84
85 • RT: CPAN's Bug Tracker
86
87 The RT ( Request Tracker ) website is the default bug/issue
88 tracking system for CPAN.
89
90 <http://rt.cpan.org/NoAuth/Bugs.html?Dist=Test-Pod-Spelling-CommonMistakes>
91
92 • AnnoCPAN
93
94 The AnnoCPAN is a website that allows community annotations of Perl
95 module documentation.
96
97 <http://annocpan.org/dist/Test-Pod-Spelling-CommonMistakes>
98
99 • CPAN Ratings
100
101 The CPAN Ratings is a website that allows community ratings and
102 reviews of Perl modules.
103
104 <http://cpanratings.perl.org/d/Test-Pod-Spelling-CommonMistakes>
105
106 • CPAN Forum
107
108 The CPAN Forum is a web forum for discussing Perl modules.
109
110 <http://cpanforum.com/dist/Test-Pod-Spelling-CommonMistakes>
111
112 • CPANTS
113
114 The CPANTS is a website that analyzes the Kwalitee ( code metrics )
115 of a distribution.
116
117 <http://cpants.cpanauthors.org/dist/overview/Test-Pod-Spelling-CommonMistakes>
118
119 • CPAN Testers
120
121 The CPAN Testers is a network of smokers who run automated tests on
122 uploaded CPAN distributions.
123
124 <http://www.cpantesters.org/distro/T/Test-Pod-Spelling-CommonMistakes>
125
126 • CPAN Testers Matrix
127
128 The CPAN Testers Matrix is a website that provides a visual
129 overview of the test results for a distribution on various
130 Perls/platforms.
131
132 <http://matrix.cpantesters.org/?dist=Test-Pod-Spelling-CommonMistakes>
133
134 • CPAN Testers Dependencies
135
136 The CPAN Testers Dependencies is a website that shows a chart of
137 the test results of all dependencies for a distribution.
138
139 <http://deps.cpantesters.org/?module=Test::Pod::Spelling::CommonMistakes>
140
141 Email
142 You can email the author of this module at "APOCAL at cpan.org" asking
143 for help with any problems you have.
144
145 Internet Relay Chat
146 You can get live help by using IRC ( Internet Relay Chat ). If you
147 don't know what IRC is, please read this excellent guide:
148 <http://en.wikipedia.org/wiki/Internet_Relay_Chat>. Please be courteous
149 and patient when talking to us, as we might be busy or sleeping! You
150 can join those networks/channels and get help:
151
152 • irc.perl.org
153
154 You can connect to the server at 'irc.perl.org' and join this
155 channel: #perl-help then talk to this person for help: Apocalypse.
156
157 • irc.freenode.net
158
159 You can connect to the server at 'irc.freenode.net' and join this
160 channel: #perl then talk to this person for help: Apocal.
161
162 • irc.efnet.org
163
164 You can connect to the server at 'irc.efnet.org' and join this
165 channel: #perl then talk to this person for help: Ap0cal.
166
167 Bugs / Feature Requests
168 Please report any bugs or feature requests by email to
169 "bug-test-pod-spelling-commonmistakes at rt.cpan.org", or through the
170 web interface at
171 <http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Test-Pod-Spelling-CommonMistakes>.
172 You will be automatically notified of any progress on the request by
173 the system.
174
175 Source Code
176 The code is open to the world, and available for you to hack on. Please
177 feel free to browse it and play with it, or whatever. If you want to
178 contribute patches, please send me a diff or prod me to pull from your
179 repository :)
180
181 <https://github.com/apocalypse/perl-test-pod-spelling-commonmistakes>
182
183 git clone git://github.com/apocalypse/perl-test-pod-spelling-commonmistakes.git
184
186 Apocalypse <APOCAL@cpan.org>
187
189 This software is copyright (c) 2014 by Apocalypse.
190
191 This is free software; you can redistribute it and/or modify it under
192 the same terms as the Perl 5 programming language system itself.
193
194 The full text of the license can be found in the LICENSE file included
195 with this distribution.
196
198 THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
199 APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
200 HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT
201 WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT
202 LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
203 PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE
204 OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU
205 ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
206
207 IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
208 WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR
209 CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
210 INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES
211 ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT
212 NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES
213 SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO
214 OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY
215 HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
216
217
218
219perl v5.36.0 2022-T0e7s-t2:2:Pod::Spelling::CommonMistakes(3pm)