Pod::Spell::CommonMistakes(3pm)

1Pod::Spell::CommonMistaUkseesr(3Cpomn)tributed Perl DocuPmoedn:t:aStpieolnl::CommonMistakes(3pm)
2
3
4

NAME

6       Pod::Spell::CommonMistakes - Catches common typos in POD
7

VERSION

9         This document describes v1.002 of Pod::Spell::CommonMistakes - released November 04, 2014 as part of Pod-Spell-CommonMistakes.
10

SYNOPSIS

12               #!/usr/bin/perl
13               use strict; use warnings;
14
15               use Pod::Spell::CommonMistakes qw( check_pod );
16
17               my $file = $ARGV[0] || 'lib/Pod/Spell/CommonMistakes.pm';
18               my $result = check_pod( $file );
19               if ( keys %$result == 0 ) {
20                       print "File passed tests!\n";
21               } else {
22                       print "File failed tests!\n";
23                       foreach my $k ( keys %$result ) {
24                               print " Found: '$k' - Possible spelling: '$result->{$k}'?\n";
25                       }
26               }
27

DESCRIPTION

29       This module looks for any typos in your POD. It differs from Pod::Spell
30       or Test::Spelling because it uses a custom wordlist and doesn't use the
31       system spellchecker. The idea for this came from the
32       <http://wiki.debian.org/Teams/Lintian> code in Debian, thanks!
33
34       To use this, just pass it a filename that has POD in it and you'll get
35       a hashref back. If the hashref is empty that means the checker found no
36       misspelled words. If it contains keys, then the keys are the bad words
37       and the values are the suggested spelling.
38

METHODS

40   check_pod( $filename )
41       This function is what you will usually run. It will run the spell
42       checks against the POD in $filename. Warning: you would need to catch
43       any exceptions thrown from this function!
44
45       It returns a hashref of misspelled words and their suggested spelling.
46       If the hash is empty then there is no errors in the POD.
47
48   check_pod_case( $filename )
49       This function behaves the same as "check_pod( $filename )" but it uses
50       a "case" wordlist instead. The difference is that this wordlist will
51       make sure you capitalize common terms properly. One example is:
52       OpenLdap => OpenLDAP.
53
54       NOTE: This does NOT run the same checks as "check_pod( $filename )"!
55       You would need to use the "check_pod_all( $filename )" function.
56
57   check_pod_all( $filename )
58       This function behaves the same as "check_pod( $filename )" but it runs
59       all the extra checks too. Currently it's just the case wordlist but
60       others might be added in the future...
61

EXPORT

63       You would need to manually get the function you want.
64

SUPPORT

74   Perldoc
75       You can find documentation for this module with the perldoc command.
76
77         perldoc Pod::Spell::CommonMistakes
78
79   Websites
80       The following websites have more information about this module, and may
81       be of help to you. As always, in addition to those websites please use
82       your favorite search engine to discover more resources.
83
84       •   MetaCPAN
85
86           A modern, open-source CPAN search engine, useful to view POD in
87           HTML format.
88
89           <http://metacpan.org/release/Pod-Spell-CommonMistakes>
90
91       •   Search CPAN
92
93           The default CPAN search engine, useful to view POD in HTML format.
94
95           <http://search.cpan.org/dist/Pod-Spell-CommonMistakes>
96
97       •   RT: CPAN's Bug Tracker
98
99           The RT ( Request Tracker ) website is the default bug/issue
100           tracking system for CPAN.
101
102           <http://rt.cpan.org/NoAuth/Bugs.html?Dist=Pod-Spell-CommonMistakes>
103
104       •   AnnoCPAN
105
106           The AnnoCPAN is a website that allows community annotations of Perl
107           module documentation.
108
109           <http://annocpan.org/dist/Pod-Spell-CommonMistakes>
110
111       •   CPAN Ratings
112
113           The CPAN Ratings is a website that allows community ratings and
114           reviews of Perl modules.
115
116           <http://cpanratings.perl.org/d/Pod-Spell-CommonMistakes>
117
118       •   CPAN Forum
119
120           The CPAN Forum is a web forum for discussing Perl modules.
121
122           <http://cpanforum.com/dist/Pod-Spell-CommonMistakes>
123
124       •   CPANTS
125
126           The CPANTS is a website that analyzes the Kwalitee ( code metrics )
127           of a distribution.
128
129           <http://cpants.cpanauthors.org/dist/overview/Pod-Spell-CommonMistakes>
130
131       •   CPAN Testers
132
133           The CPAN Testers is a network of smokers who run automated tests on
134           uploaded CPAN distributions.
135
136           <http://www.cpantesters.org/distro/P/Pod-Spell-CommonMistakes>
137
138       •   CPAN Testers Matrix
139
140           The CPAN Testers Matrix is a website that provides a visual
141           overview of the test results for a distribution on various
142           Perls/platforms.
143
144           <http://matrix.cpantesters.org/?dist=Pod-Spell-CommonMistakes>
145
146       •   CPAN Testers Dependencies
147
148           The CPAN Testers Dependencies is a website that shows a chart of
149           the test results of all dependencies for a distribution.
150
151           <http://deps.cpantesters.org/?module=Pod::Spell::CommonMistakes>
152
153   Email
154       You can email the author of this module at "APOCAL at cpan.org" asking
155       for help with any problems you have.
156
157   Internet Relay Chat
158       You can get live help by using IRC ( Internet Relay Chat ). If you
159       don't know what IRC is, please read this excellent guide:
160       <http://en.wikipedia.org/wiki/Internet_Relay_Chat>. Please be courteous
161       and patient when talking to us, as we might be busy or sleeping! You
162       can join those networks/channels and get help:
163
164       •   irc.perl.org
165
166           You can connect to the server at 'irc.perl.org' and join this
167           channel: #perl-help then talk to this person for help: Apocalypse.
168
169       •   irc.freenode.net
170
171           You can connect to the server at 'irc.freenode.net' and join this
172           channel: #perl then talk to this person for help: Apocal.
173
174       •   irc.efnet.org
175
176           You can connect to the server at 'irc.efnet.org' and join this
177           channel: #perl then talk to this person for help: Ap0cal.
178
179   Bugs / Feature Requests
180       Please report any bugs or feature requests by email to
181       "bug-pod-spell-commonmistakes at rt.cpan.org", or through the web
182       interface at
183       <http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Pod-Spell-CommonMistakes>.
184       You will be automatically notified of any progress on the request by
185       the system.
186
187   Source Code
188       The code is open to the world, and available for you to hack on. Please
189       feel free to browse it and play with it, or whatever. If you want to
190       contribute patches, please send me a diff or prod me to pull from your
191       repository :)
192
193       <https://github.com/apocalypse/perl-pod-spell-commonmistakes>
194
195         git clone https://github.com/apocalypse/perl-pod-spell-commonmistakes.git
196

AUTHOR

198       Apocalypse <APOCAL@cpan.org>
199

ACKNOWLEDGEMENTS

201       Props goes out to jawnsy@irc for pointing out a spelling mistake in
202       POE, which prompted me to write this.
203
204       THANKS goes out to the Debian Lintian code, as it was a great starting
205       place! <http://wiki.debian.org/Teams/Lintian>
206

COPYRIGHT AND LICENSE

208       This software is copyright (c) 2014 by Apocalypse.
209
210       This is free software; you can redistribute it and/or modify it under
211       the same terms as the Perl 5 programming language system itself.
212
213       The full text of the license can be found in the LICENSE file included
214       with this distribution.
215

DISCLAIMER OF WARRANTY

217       THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
218       APPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
219       HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT
220       WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT
221       LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
222       PARTICULAR PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE
223       OF THE PROGRAM IS WITH YOU.  SHOULD THE PROGRAM PROVE DEFECTIVE, YOU
224       ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
225
226       IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
227       WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR
228       CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
229       INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES
230       ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT
231       NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES
232       SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO
233       OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY
234       HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
235
236
237
238perl v5.32.1                      2021-01-27   Pod::Spell::CommonMistakes(3pm)