PODLINT(1)

πŸ’… podlint(1) β€” the pod checker bestie

okay so real talk: this page lives in the User Contributed Perl Documentation section, and it's about podlint β€” the little script that reads your POD and tells you if it's a mess. no cap, it's giving "your friend who proofreads your texts before you send them." πŸŽ€


✨ NAME ✨

podlint β€” check POD for correctness using Pod::POM πŸ’–


✨ SYNOPSIS ✨

podlint MyFile.pm

that's it. that's the whole vibe. point it at a file and let it cook. πŸ“


✨ DESCRIPTION ✨

so here's the tea β˜• β€” this script uses Pod::POM to parse a Pod document with full warnings enabled, which basically means it's acting as a syntax and structure checker. think of it as a vibe check for your documentation, except the vibe check is extremely thorough and will absolutely tell you what's wrong. 😭

you can also pass the -f option, and then the parsed Pod Object Model gets printed to STDOUT with any markup errors fixed. slay. ✨

⚠️ but bestie, listen β€” there are some critical parse errors that the parser genuinely can't handle or fix. when that happens, the script will terminate and report the error. so like… sometimes it's not a glow-up, it's just an error message. πŸ’€

🌸 AUTHOR 🌸

Andy Wardley <abw@kfs.org> β€” an icon, an absolute legend πŸ‘‘


πŸ¦‹ VERSION πŸ¦‹

this is version 0.2 of podlint. short and sweet, she's still young πŸ’œ


Copyright (C) 2000, 2001 Andy Wardley. All Rights Reserved.

this module is free software; you can redistribute it and/or modify it under the same terms as Perl itself. periodt. πŸ’…


🌈 SEE ALSO 🌈

for further information please see Pod::POM β€” that's where all the actual lore lives 🫢


mwah πŸ’– that's the page! signed off from the perl v5.42.0 era, dated 2015-11-20, still serving looks. go lint your pods bestie, iykyk 🌸✨

πŸ“¦ where this page comes from