Pod::S...stakes(3pm)

📦
version 1.002 · 2 versions
, in fedora 43

💖 NAME 💖

okay so bestie, welcome to the manual page for Pod::Spell::CommonMistakes (it's a 3pm page, iykyk) — and its whole entire job is catching those common typos in your POD. periodt 💅

🎀 VERSION 🎀

This doc is describing v1.002 of Pod::Spell::CommonMistakes — it was released November 04, 2014 and it's part of the Pod-Spell-CommonMistakes distribution 🦋

🌸 SYNOPSIS 🌸

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

use Pod::Spell::CommonMistakes qw( check_pod );

my $file = $ARGV[0] || 'lib/Pod/Spell/CommonMistakes.pm';
my $result = check_pod( $file );
if ( keys %$result == 0 ) {
    print "File passed tests!\n";
} else {
    print "File failed tests!\n";
    foreach my $k ( keys %$result ) {
        print " Found: '$k' - Possible spelling: '$result->{$k}'?\n";
    }
}

🌈 DESCRIPTION 🌈

This module goes looking for any typos in your POD, fr fr. The way it's different from Pod::Spell or Test::Spelling? It uses a custom wordlist and does NOT use the system spellchecker, no cap. The idea for this came from the Debian Lintian code — <http://wiki.debian.org/Teams/Lintian> — thanks bestie! 🫶

To use it, you just pass it a filename that has POD in it and you get a hashref back. If that hashref is empty, that means the checker found no misspelled words. If it's got keys in it, then those keys are the bad words and the values are the suggested spelling ✨

👑 METHODS 👑

check_pod( $filename )

This is the function you'll usually run, lowkey the main character. It runs the spell checks against the POD in $filename.

⚠️ Warning bestie: you would need to catch any exceptions thrown from this function! 👀

It returns a hashref of misspelled words and their suggested spelling. If the hash is empty then there is no errors in the POD 💖

check_pod_case( $filename )

This one behaves the same as check_pod( $filename ) but it uses a "case" wordlist instead. The difference is that this wordlist will make sure you capitalize common terms properly. One example is: OpenLdap => OpenLDAP 💅

🚨 NOTE: This does NOT run the same checks as check_pod( $filename )! You would need to use the check_pod_all( $filename ) function.

check_pod_all( $filename )

Behaves the same as check_pod( $filename ) but it runs all the extra checks too. Currently it's just the case wordlist but others might be added in the future... 👀✨

🦋 EXPORT 🦋

You would need to manually get the function you want — no auto-magic here, you gotta grab it yourself bestie 🙈

⭐ SEE ALSO ⭐

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

  • Pod::Spell
  • Test::Pod::Spelling::CommonMistakes

💜 SUPPORT 💜

Perldoc

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

perldoc Pod::Spell::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.

Email

You can email the author of this module at APOCAL at cpan.org asking for help with any problems you have 💌

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-pod-spell-commonmistakes at rt.cpan.org, or through the web interface at <http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Pod-Spell-CommonMistakes>. You will be automatically notified of any progress on the request by the system 🔔

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-pod-spell-commonmistakes>

git clone https://github.com/apocalypse/perl-pod-spell-commonmistakes.git

💖 AUTHOR 💖

Apocalypse <APOCAL@cpan.org>

🙈 ACKNOWLEDGEMENTS 🙈

Props goes out to jawnsy@irc for pointing out a spelling mistake in POE, which prompted me to write this 🌸

THANKS goes out to the Debian Lintian code, as it was a great starting place! <http://wiki.debian.org/Teams/Lintian>

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 bestie, here's the serious legal bit — keeping it 100% real and word-for-word because that's how warranties work 🙈

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 thing bestie 💖 this was rendered by perl v5.42.0, dated 2025-07-25, and the page is the iconically-truncated Pod::S...stakes(3pm) — now go fix those typos, slay ✨👑

📦 where this page comes from