Perl::...dAtEnd(3pm)

💖 NAME 💖

Okay bestie, buckle up — this is the manual page for Perl::Critic::Policy::Documentation::RequirePodAtEnd (the header shortens it to Perl::...dAtEnd(3pm) because terminals are drama queens about width). The whole vibe: all POD should be after __END__. That's it, that's the policy. ✨

---

🫶 AFFILIATION 🫶

This Policy is part of the core Perl::Critic distribution — so it ships with the main squad, no extra install required. 💅

---

🌸 DESCRIPTION 🌸

So here's the tea, bestie: Perl stops processing code the moment it hits an __END__ statement. Which means if you shove your docs after __END__, Perl literally doesn't have to look at them — and that's faster, because saving processing time is the whole game. 🔥

Also (and this is the underrated part), writing all the POD in one place usually leads to a more cohesive document, instead of your documentation being forced to follow the layout of your code like some kind of hostage situation. 😭

This policy issues violations if any POD is found before an __END__. Periodt.

---

🎀 CONFIGURATION 🎀

This Policy is not configurable except for the standard options. That's the whole section. Nothing to tune here, bestie — it already knows what it wants. 🧚

---

👑 NOTES 👑

Some folks like to use =for, =begin, and =end tags to create block comments in-line with their code. And honestly? Respect. 🙈 Since those tags aren't usually part of the documentation, this Policy does allow them to appear before the __END__ statement. Iconic of it, honestly.

=begin comments

frobulate()
Accepts:  A list of things to frobulate
Returns:  True if successful

=end comments

sub frobulate { ... }

---

🌈 AUTHOR 🌈

Chris Dolan <cdolan@cpan.org> — go say hi, they made this. 💜

---

⭐ COPYRIGHT ⭐

Copyright (c) 2006-2011 Chris Dolan.

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself. The full text of this license can be found in the LICENSE file included with this module. 🫶

---

ngl if you got all the way here you're literally the main character of documentation-reading. ate and left no crumbs. 💅

kisses, bestie — this was perl v5.42.0, dated 2024-10-23 🎀✨🦋