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

πŸ“¦
version 0.009 Β· 4 versions
, in debian bookworm, debian trixie, ubuntu noble, ubuntu resolute, ubuntu stonking

πŸ’– Pod::Weaver::Section::Contributors β€” the whole vibe πŸ’–

okay bestie, so this is Pod::Weaver::Section::Contributors, living in the User Contributed Perl Documentation section of your manual, and it's here to give credit where credit is due. It's the little section that goes "hey, these people helped" and it is iconic for it. πŸ’…

✨ NAME ✨

Pod::Weaver::Section::Contributors β€” a section listing contributors. literally what it says on the tin, no cap. πŸ‘‘

🌸 VERSION 🌸

version 0.009

πŸ¦‹ SYNOPSIS πŸ¦‹

so there's like three ways to summon this thing, and you can mix and match, fr fr.

option one: on dist.ini:

[PodWeaver]
[%PodWeaver]
Contributors.head = 2
Contributors.contributors[0] = keedi - Keedi Kim - κΉ€λ„ν˜• (cpan: KEEDI) <keedi@cpan.org>
Contributors.contributors[1] = carandraug - CarnΓ« Draug (cpan: CDRAUG) <cdraug@cpan.org>

and/or on weaver.ini:

[Contributors]
head = 2
contributors = keedi - Keedi Kim - κΉ€λ„ν˜• (cpan: KEEDI) <keedi@cpan.org>
contributors = carandraug - CarnΓ« Draug (cpan: CDRAUG) <cdraug@cpan.org>

and/or straight up in the source of individual files:

# CONTRIBUTOR:  keedi - Keedi Kim - κΉ€λ„ν˜• (cpan: KEEDI) <keedi@cpan.org>
# CONTRIBUTORS: carandraug - CarnΓ« Draug (cpan: CDRAUG) <cdraug@cpan.org>

like, pick your fighter. all three are valid. 🫢

🌈 DESCRIPTION 🌈

okay so here's the tea: this section adds a listing of the document's contributors. it's expecting a contributors input parameter that's an arrayref of strings. that's the whole deal.

if you don't hand it a contributors parameter? it does absolutely nothing. silence. ghosting. πŸ™ˆ

but if you do, it produces a hunk like this:

=head1 CONTRIBUTORS

Contributor One <a1@example.com>
Contributor Two <a2@example.com>

and now the fancy part: to support distributions with multiple modules, it can also derive a list of contributors on a file basis by looking at comments on each module. so names of contributors on the source will only appear on the POD of those modules β€” not everywhere, just the ones they actually touched. main character energy but make it local. ✨

πŸ‘‘ ATTRIBUTES πŸ‘‘

the heading level of this section. if it's 0, it inserts an ordinary piece of text with no heading at all. defaults to 1.

and listen β€” in case the value is passed both to Pod::Weaver and to the Pod::Weaver stash, it uses the value found in the stash. stash wins, periodt.

πŸŽ€ contributors

the list of contributors. that's it, that's the attribute.

in case the value is passed to weave_section(), to Pod::Weaver and to the Pod::Weaver stash, it merges all contributors. everybody gets credit, nobody gets left out. πŸ’–

🧚 all_modules

enable this if you want to add the CONTRIBUTOR/CONTRIBUTORS section to all the modules in a dist, not only the main one. defaults to false.

in case the value is passed both to Pod::Weaver and to the Pod::Weaver stash, it uses the value found in the stash. (same energy as head, bestie, consistent queen. πŸ’…)

πŸ”₯ SEE ALSO πŸ”₯

a whole reading list, go off. πŸ“š

🌟 AUTHOR 🌟

Keedi Kim - κΉ€λ„ν˜• <keedi@cpan.org>

πŸ’ž CONTRIBUTORS πŸ’ž

  • carandraug - CarnΓ« Draug (cpan: CDRAUG) <cdraug@cpan.org>
  • ether - Karen Etheridge (cpan: ETHER) <ether@cpan.org>
  • thaljef - Jeffrey Ryan Thalhammer (cpan: THALJEF) <thaljef@cpan.org>

look at that, the page about contributors has contributors. it's giving self-aware. πŸ˜­πŸ’–

this software is copyright (c) 2014 by Keedi Kim.

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.34.0, dated 2022-06-16, and it lives at Pod::W...butors(3pm) in the manual β€” yes the title's abbreviated, don't worry about it, that's just how the header do. mwah, go credit your contributors, they earned it. πŸ’‹πŸ¦‹
πŸ“¦ where this page comes from