1Test2::Tools::Explain(3U)ser Contributed Perl DocumentatiToenst2::Tools::Explain(3)
2
3
4

NAME

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

VERSION

9       Version 0.02
10

SYNOPSIS

12       Test2::Suite dropped the "explain()" function that had been part of
13       Test::More.  For those who miss it in Test2, you can use
14       Test2::Tools::Explain.
15
16           use Test2::Tools::Explain;
17
18           my $errors = fleeble_the_whatzit();
19           is( $errors, [], 'Should have no errors from fleebling' ) or diag explain( $errors );
20

EXPORTS

22       All functions in this module are exported by default.
23

SUBROUTINES

25   explain( @things_to_explain )
26       Will convert the contents of any references in a human readable format,
27       and return them as strings.  Usually you want to pass this into "note"
28       or "diag".
29
30       Handy for things like:
31
32           is( $errors, [], 'Should have no errors' ) or diag explain( $errors );
33
34       Note that "explain" does NOT output anything.
35

AUTHOR

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

BUGS

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

SUPPORT

46       You can find documentation for this module with the perldoc command.
47
48           perldoc Test2::Tools::Explain
49
50       You can also look for information at:
51
52       •   GitHub project page
53
54           <https://github.com/petdance/test2-tools-explain>
55
56       •   Search CPAN
57
58           <http://search.cpan.org/dist/Test2-Tools-Explain/>
59
60       •   AnnoCPAN: Annotated CPAN documentation
61
62           <http://annocpan.org/dist/Test2-Tools-Explain>
63
64       •   CPAN Ratings
65
66           <http://cpanratings.perl.org/d/Test2-Tools-Explain>
67

ACKNOWLEDGEMENTS

69       The code for "explain" is originally from "Test::More" by Michael
70       Schwern, who took it from "Test::Most" by Curtis Poe.
71

73       Copyright 2016 Andy Lester.
74
75       This program is free software; you can redistribute it and/or modify it
76       under the terms of the the Artistic License (2.0). You may obtain a
77       copy of the full license at:
78
79       <http://www.perlfoundation.org/artistic_license_2_0>
80
81       Any use, modification, and distribution of the Standard or Modified
82       Versions is governed by this Artistic License. By using, modifying or
83       distributing the Package, you accept this license. Do not use, modify,
84       or distribute the Package, if you do not accept this license.
85
86       If your Modified Version has been derived from a Modified Version made
87       by someone other than you, you are nevertheless required to ensure that
88       your Modified Version complies with the requirements of this license.
89
90       This license does not grant you the right to use any trademark, service
91       mark, tradename, or logo of the Copyright Holder.
92
93       This license includes the non-exclusive, worldwide, free-of-charge
94       patent license to make, have made, use, offer to sell, sell, import and
95       otherwise transfer the Package with respect to any patent claims
96       licensable by the Copyright Holder that are necessarily infringed by
97       the Package. If you institute patent litigation (including a cross-
98       claim or counterclaim) against any party alleging that the Package
99       constitutes direct or contributory patent infringement, then this
100       Artistic License to you shall terminate on the date that such
101       litigation is filed.
102
103       Disclaimer of Warranty: THE PACKAGE IS PROVIDED BY THE COPYRIGHT HOLDER
104       AND CONTRIBUTORS "AS IS' AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES.
105       THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
106       PURPOSE, OR NON-INFRINGEMENT ARE DISCLAIMED TO THE EXTENT PERMITTED BY
107       YOUR LOCAL LAW. UNLESS REQUIRED BY LAW, NO COPYRIGHT HOLDER OR
108       CONTRIBUTOR WILL BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, OR
109       CONSEQUENTIAL DAMAGES ARISING IN ANY WAY OUT OF THE USE OF THE PACKAGE,
110       EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
111
112
113
114perl v5.36.0                      2022-07-22          Test2::Tools::Explain(3)
Impressum