Test::...istakes(3pm)

📦
version 1.001 · 2 versions
, in fedora 43

🌸 hey bestie, welcome to the manual 🌸

okay so real talk: this page lives in the User Contributed Perl Documentation pile, and its little title tag is Test::...istakes(3pm) (yes it's truncated, no we don't know why, the 3pm just means "Perl module manpage" 💅). The full glow-up name is right below, so let's get into it.

✨ NAME ✨

Test::Pod::Spelling::CommonMistakes — Checks POD for common spelling mistakes

🎀 VERSION 🎀

This doc describes v1.001 of Test::Pod::Spelling::CommonMistakes — released October 31, 2014 as part of Test-Pod-Spelling-CommonMistakes. vintage but iconic fr fr 🫶

🦋 SYNOPSIS 🦋

#!/usr/bin/perl
use strict; use warnings;

use Test::More;

eval "use Test::Pod::Spelling::CommonMistakes";
if ( $@ ) {
        plan skip_all => 'Test::Pod::Spelling::CommonMistakes required for testing POD';
} else {
        all_pod_files_ok();
}

💖 DESCRIPTION 💖

So here's the vibe: this module checks your POD for common spelling errors. And it's not like other spelling checkers — it does not use your system spellchecker. Instead it hands the heavy lifting off to Pod::Spell::CommonMistakes. Using it is literally the same as any standard Test::* module, exactly like the snippet above shows. no cap. 🔥

👑 METHODS 👑

💅 all_pod_files_ok( [ @files ] )

This is the one you'll usually be running, bestie. It automatically finds any POD in your distribution and runs checks on them. main character energy tbh.

It accepts one optional argument: an array of files to check. By default it checks all the POD files it can find in the distribution. Every single file it finds gets passed to the pod_file_ok() function. 🎀

🌈 pod_file_ok( $file, [ $name ] )

pod_file_ok() will okay the test if there are spelling errors present in the POD. (Yes, that's how it reads — the test passes when it finds the mistakes it's hunting for. iykyk.)

Also important: if the POD was malformed, as reported by Pod::Simple, the test will fail and it will not attempt to check spelling. vibe check: failed. 💀

When it fails, pod_file_ok() will show any misspelled words and their suggested spelling as diagnostics. very helpful of it.

The optional second argument $name is the name of the test. If you omit it, pod_file_ok() picks a default test name: "Spelling test for $file". cute default, honestly. 💜

🌸 EXPORT 🌸

Automatically exports the two subs. that's it, that's the section. ✨

⭐ SEE ALSO ⭐

Please see those modules/websites for more information related to this module.

  • Pod::Spell::CommonMistakes

🧚 SUPPORT 🧚

🍓 Perldoc

You can find documentation for this module with the perldoc command.

perldoc Test::Pod::Spelling::CommonMistakes

🌈 Websites

The following websites have more information about this module, and may be of help to you. As always, in addition to those websites please use your favorite search engine to discover more resources. (go forth and google, bestie 🔍)

  • MetaCPAN — A modern, open-source CPAN search engine, useful to view POD in HTML format.

<http://metacpan.org/release/Test-Pod-Spelling-CommonMistakes>

  • Search CPAN — The default CPAN search engine, useful to view POD in HTML format.

<http://search.cpan.org/dist/Test-Pod-Spelling-CommonMistakes>

  • RT: CPAN's Bug Tracker — The RT ( Request Tracker ) website is the default bug/issue tracking system for CPAN.

<http://rt.cpan.org/NoAuth/Bugs.html?Dist=Test-Pod-Spelling-CommonMistakes>

  • AnnoCPAN — The AnnoCPAN is a website that allows community annotations of Perl module documentation.

<http://annocpan.org/dist/Test-Pod-Spelling-CommonMistakes>

  • CPAN Ratings — The CPAN Ratings is a website that allows community ratings and reviews of Perl modules.

<http://cpanratings.perl.org/d/Test-Pod-Spelling-CommonMistakes>

  • CPAN Forum — The CPAN Forum is a web forum for discussing Perl modules.

<http://cpanforum.com/dist/Test-Pod-Spelling-CommonMistakes>

  • CPANTS — The CPANTS is a website that analyzes the Kwalitee ( code metrics ) of a distribution.

<http://cpants.cpanauthors.org/dist/overview/Test-Pod-Spelling-CommonMistakes>

  • CPAN Testers — The CPAN Testers is a network of smokers who run automated tests on uploaded CPAN distributions.

<http://www.cpantesters.org/distro/T/Test-Pod-Spelling-CommonMistakes>

  • CPAN Testers Matrix — The CPAN Testers Matrix is a website that provides a visual overview of the test results for a distribution on various Perls/platforms.

<http://matrix.cpantesters.org/?dist=Test-Pod-Spelling-CommonMistakes>

  • CPAN Testers Dependencies — The CPAN Testers Dependencies is a website that shows a chart of the test results of all dependencies for a distribution.

<http://deps.cpantesters.org/?module=Test::Pod::Spelling::CommonMistakes>

💌 Email

You can email the author of this module at APOCAL at cpan.org asking for help with any problems you have. slide into their inbox, respectfully. 🫶

🦋 Internet Relay Chat

You can get live help by using IRC ( Internet Relay Chat ). If you don't know what IRC is, please read this excellent guide: <http://en.wikipedia.org/wiki/Internet_Relay_Chat>. Please be courteous and patient when talking to us, as we might be busy or sleeping! You can join those networks/channels and get help:

  • irc.perl.org

You can connect to the server at 'irc.perl.org' and join this channel: #perl-help then talk to this person for help: Apocalypse.

  • irc.freenode.net

You can connect to the server at 'irc.freenode.net' and join this channel: #perl then talk to this person for help: Apocal.

  • irc.efnet.org

You can connect to the server at 'irc.efnet.org' and join this channel: #perl then talk to this person for help: Ap0cal.

🐛 Bugs / Feature Requests

Please report any bugs or feature requests by email to bug-test-pod-spelling-commonmistakes at rt.cpan.org, or through the web interface at <http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Test-Pod-Spelling-CommonMistakes>. You will be automatically notified of any progress on the request by the system. so you won't be left on read. 💅

💾 Source Code

The code is open to the world, and available for you to hack on. Please feel free to browse it and play with it, or whatever. If you want to contribute patches, please send me a diff or prod me to pull from your repository :)

<https://github.com/apocalypse/perl-test-pod-spelling-commonmistakes>

git clone git://github.com/apocalypse/perl-test-pod-spelling-commonmistakes.git

💜 AUTHOR 💜

Apocalypse <APOCAL@cpan.org>

This software is copyright (c) 2014 by Apocalypse.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.

The full text of the license can be found in the LICENSE file included with this distribution.

⚠️ DISCLAIMER OF WARRANTY ⚠️

okay this is the serious part, so listen up bestie:

THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.

IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

and that's the whole page, bestie! 🫶 this gorgeous lil doc was rendered by perl v5.42.0 on 2025-07-25, and yes, the page tag was still that iconic Test::...istakes(3pm). periodt. 💖✨
📦 where this page comes from