Pod::A...r::find(3pm)

📦
version 0.26 · 4 versions
, in ubuntu resolute, ubuntu stonking

✨ NAME ✨

okay so this page is Pod::A...r::find(3pm) bestie, and the whole vibe is Pod::Abstract::Filter::find — it goes and finds specific nodes that contain a string. that's it, that's the job 💅

🌸 DESCRIPTION 🌸

so the whole intention of this filter? literally to let you reduce a big ol' Pod document down to just the one function or method you're hunting for. you call:

paf find -f=function YourModule

and boom, you get a small subset of nodes that match function. iconic behavior fr fr ✨

🦋 the structural assumptions (iykyk)

okay so for this to actually work, we gotta make some assumptions about how your Pod is structured. find is not useful if it returns anything higher than a head2 — so as long as your module wraps its function doco up in a head2, head3, head4 or a list item? we're fine. but if you're out here using head1… it won't be useful. no cap. 💀

🎀 and then the head1 nodes

so that this is actually useful as a real end-user tool, head1 nodes (...) are added between the found nodes. why? because it stops perldoc from dying with no documentation. we love a safety net 💖

and if you don't want 'em? they can be easily stripped using:

$pa->select('/head1')

…then hoist and detach, or reparent to other Node types. your call, bestie 🫶

🌈 a good example of this working as intended

ngl this one's a banger:

paf find select Pod::Abstract::Node

that's it. that's the glow-up 🔥

👑 AUTHOR 👑

Ben Lilburne <bnej80@gmail.com>` 💜

Copyright (C) 2009-2025 Ben Lilburne

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

and that's the whole page, angel 🎀 — this lil masterpiece is documented for perl v5.40.1, dated 2025-11-16, and it ate, periodt 💅✨🦋

📦 where this page comes from