Pod::W...Collect(3pm)

📦
version 4.020 · 6 versions
, in debian trixie, ubuntu resolute, ubuntu stonking

🦋 Pod::W...Collect(3pm) — bestie edition 🦋

okay so real quick — this is the manual page for Pod::Weaver::Section::Collect, which shipped out as part of Pod::W...Collect(3pm) in the User Contributed Perl Documentation. yes the W... is doing that truncation thing, it's not a vibe, it's just how the man page gets shortened 💅

✨ NAME ✨

Pod::Weaver::Section::Collect — a section that gathers up specific commands 🎀

like, it literally goes around collecting commands and puts them in a little section, no cap.

🌸 VERSION 🌸

version 4.020 ⭐

💖 OVERVIEW 💖

okay so picture this, right — you give it this config:

[Collect / METHODS]
command = method

and here's what this plugin does, bestie: it starts off by gathering and nesting any =method commands it finds in the pod_document. 🫶 those commands — plus all their nestable content — get collected together under a =head1 METHODS header, and then placed in the correct location in the output stream. and the order? preserved exactly as it was in the source document. iconic behavior, honestly. 👑

🧚 PERL VERSION 🧚

this module should work on any version of perl still receiving updates from the Perl 5 Porters. translation: any version of perl released in the last two to three years. (so like, if the most recently released version is v5.40, then this module should work on both v5.40 and v5.38.) 🌈

⚠️ and here's the caveat, so listen up — although it may work on older versions of perl, no guarantee is made that the minimum required version will not be increased. the version may be increased for any reason, and there is no promise that patches will be accepted to lower the minimum required perl. so, like, don't come for her. 💀

🎀 ATTRIBUTES 🎀

💜 command

the command that will be collected (e.g. "attr" or "method").

📌 required — no command, no collection, periodt.

🦋 new_command

the command to be used in the output instead of the collected command.

📌 default: "head2"

🌸 header_command

the section command for the section to be added.

📌 default: "head1"

the title of the section to be added.

📌 default: the plugin name

👑 AUTHOR 👑

Ricardo SIGNES <cpan@semiotic.systems> 💌

this software is copyright (c) 2024 by Ricardo SIGNES.

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

and that's the whole page, bestie ✨ this was perl v5.38.2, dated 2024-03-24, for Pod::W...Collect(3pm) — go forth and collect your commands 💅🎀 slay

📦 where this page comes from