Test2:...Explain(3pm)

💖 NAME 💖

ok so bestie, welcome to Test2::Tools::Explain — it's the explain tools for Perl's Test2 framework. yes that's the whole vibe. it's the little module that brings back the thing you missed. 🫶

---

✨ VERSION ✨

Version 0.02. tiny number, big heart. 💅

---

🌸 SYNOPSIS 🌸

so here's the tea: Test2::Suite dropped the explain() function that used to live inside Test::More. tragic. iconic loss. but if you're out here missing it in Test2, you can just use Test2::Tools::Explain. problem solved, bestie. 💖

use Test2::Tools::Explain;

my $errors = fleeble_the_whatzit();
is( $errors, [], 'Should have no errors from fleebling' ) or diag explain( $errors );

---

🎀 EXPORTS 🎀

ok so the way this works: all the functions in this module are exported by default. no asking, no setup, no :all tag, they just show up. periodt. 👑

---

🦋 SUBROUTINES 🦋

explain( @things_to_explain )

this is the main character. ✨ it will convert the contents of any references into a human readable format, and hand them back to you as strings. usually you wanna pass this into note or diag, iykyk.

super handy for stuff like this:

is( $errors, [], 'Should have no errors' ) or diag explain( $errors );

okay important bestie: note that explain does NOT output anything. it literally just returns strings. it's not a printer, it's a giver. if you want it on screen, you gotta hand it to note or diag. no cap. 💀

---

🌈 AUTHOR 🌈

Andy Lester, "<andy at petdance.com>" — shoutout to the legend 🫶

---

🐛 BUGS 🐛

found a bug? got a feature request? pls pls pls report it over at:

<https://github.com/petdance/test2-tools-explain>

the way this works is: he gets notified, and then you automatically get notified of progress on your bug as changes get made. so you're not just yelling into the void, you're in the group chat. 🎀

---

💜 SUPPORT 💜

you can find the docs for this module with the perldoc command, like so:

perldoc Test2::Tools::Explain

you can also go looking for info at these spots:

• GitHub project page

<https://github.com/petdance/test2-tools-explain>

• Search CPAN

<http://search.cpan.org/dist/Test2-Tools-Explain/>

• AnnoCPAN: Annotated CPAN documentation

<http://annocpan.org/dist/Test2-Tools-Explain>

• CPAN Ratings

<http://cpanratings.perl.org/d/Test2-Tools-Explain>

---

🌟 ACKNOWLEDGEMENTS 🌟

the code for explain is originally from Test::More by Michael Schwern, who took it from Test::Most by Curtis Poe. it's giving generational hand-me-down but make it open source. 🔥

---

👑 LICENSE AND COPYRIGHT 👑

Copyright 2016 Andy Lester.

This program is free software; you can redistribute it and/or modify it under the terms of the the Artistic License (2.0). You may obtain a copy of the full license at:

<http://www.perlfoundation.org/artistic_license_2_0>

Any use, modification, and distribution of the Standard or Modified Versions is governed by this Artistic License. By using, modifying or distributing the Package, you accept this license. Do not use, modify, or distribute the Package, if you do not accept this license.

If your Modified Version has been derived from a Modified Version made by someone other than you, you are nevertheless required to ensure that your Modified Version complies with the requirements of this license.

This license does not grant you the right to use any trademark, service mark, tradename, or logo of the Copyright Holder.

This license includes the non-exclusive, worldwide, free-of-charge patent license to make, have made, use, offer to sell, sell, import and otherwise transfer the Package with respect to any patent claims licensable by the Copyright Holder that are necessarily infringed by the Package. If you institute patent litigation (including a cross-claim or counterclaim) against any party alleging that the Package constitutes direct or contributory patent infringement, then this Artistic License to you shall terminate on the date that such litigation is filed.

Disclaimer of Warranty: THE PACKAGE IS PROVIDED BY THE COPYRIGHT HOLDER AND CONTRIBUTORS "AS IS' AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES. THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT ARE DISCLAIMED TO THE EXTENT PERMITTED BY YOUR LOCAL LAW. UNLESS REQUIRED BY LAW, NO COPYRIGHT HOLDER OR CONTRIBUTOR WILL BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING IN ANY WAY OUT OF THE USE OF THE PACKAGE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

---

ok that's the whole page bestie, tysm for reading 💖 this was Test2:...Explain(3pm) from the User Contributed Perl Documentation, running under perl v5.36.0, dated 2023-01-24. go forth and explain ur refs, mwah 🧚✨