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

💖 NAME 💖

okay so welcome to the user-contributed Perl documentation page for Pod::W...::Name(3pm), bestie — and yes, we're getting into it. This is Pod::Weaver::Section::Name: the section plugin that will add a NAME section with abstract (for your Perl module). slay 💅✨

---

⭐ VERSION ⭐

version 4.020 — iconic, no cap 🎀

---

🌸 OVERVIEW 🌸

This section plugin will produce a hunk of Pod giving the name of the document as well as an abstract, like this:

=head1 NAME

Some::Document - a document for some

It determines the name and abstract by inspecting the ppi_document, which must be given, fr fr. It looks for comments in this form:

# ABSTRACT: a document for some
# PODNAME: Some::Package::Name

If no PODNAME comment is present, but a package declaration can be found, then the package name will be used as the document name. easy peasy 💖

---

🐪 PERL VERSION 🐪

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

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. that's the whole vibe, bestie 🫶

---

🎀 ATTRIBUTES 🎀

header

The title of the header to be added. (default: "NAME") — cute, simple, done 💅

---

🦋 AUTHOR 🦋

Ricardo SIGNES <cpan@semiotic.systems>

---

👑 COPYRIGHT AND LICENSE 👑

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 one came from perl v5.38.2, dated 2024-03-24, and it's the Pod::W...::Name(3pm) manual — bye 🫶💖