NAME

Test2::Tools::Explain -- Explain tools for Perl's Test2 framework

VERSION

Version 0.02

SYNOPSIS

Test2::Suite dropped the "explain()" function that had been part of Test::More. For those who miss it in Test2, you can use Test2::Tools::Explain.

    use Test2::Tools::Explain;

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

EXPORTS

All functions in this module are exported by default.

SUBROUTINES

explain( @things_to_explain )

Will convert the contents of any references in a human readable format, and return them as strings. Usually you want to pass this into "note" or "diag".

Handy for things like:

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

Note that "explain" does NOT output anything.

AUTHOR

Andy Lester, "<andy at petdance.com>"

BUGS

Please report any bugs or feature requests to <https://github.com/petdance/test2-tools-explain>. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

SUPPORT

You can find documentation for this module with the perldoc command.

    perldoc Test2::Tools::Explain

You can also look for information at:

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.

LICENSE AND COPYRIGHT

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.