1package Test2::EventFacet::Amnesty;
2use strict;
3use warnings;
4
5our $VERSION = '1.302175';
6
7sub is_list { 1 }
8
9BEGIN { require Test2::EventFacet; our @ISA = qw(Test2::EventFacet) }
10use Test2::Util::HashBase qw{ -tag -inherited };
11
121;
13
14__END__
15
16=pod
17
18=encoding UTF-8
19
20=head1 NAME
21
22Test2::EventFacet::Amnesty - Facet for assertion amnesty.
23
24=head1 DESCRIPTION
25
26This package represents what is expected in units of amnesty.
27
28=head1 NOTES
29
30This facet appears in a list instead of being a single item.
31
32=head1 FIELDS
33
34=over 4
35
36=item $string = $amnesty->{details}
37
38=item $string = $amnesty->details()
39
40Human readable explanation of why amnesty was granted.
41
42Example: I<Not implemented yet, will fix>
43
44=item $short_string = $amnesty->{tag}
45
46=item $short_string = $amnesty->tag()
47
48Short string (usually 10 characters or less, not enforced, but may be truncated
49by renderers) categorizing the amnesty.
50
51=item $bool = $amnesty->{inherited}
52
53=item $bool = $amnesty->inherited()
54
55This will be true if the amnesty was granted to a parent event and inherited by
56this event, which is a child, such as an assertion within a subtest that is
57marked todo.
58
59=back
60
61=head1 SOURCE
62
63The source code repository for Test2 can be found at
64F<http://github.com/Test-More/test-more/>.
65
66=head1 MAINTAINERS
67
68=over 4
69
70=item Chad Granum E<lt>exodist@cpan.orgE<gt>
71
72=back
73
74=head1 AUTHORS
75
76=over 4
77
78=item Chad Granum E<lt>exodist@cpan.orgE<gt>
79
80=back
81
82=head1 COPYRIGHT
83
84Copyright 2019 Chad Granum E<lt>exodist@cpan.orgE<gt>.
85
86This program is free software; you can redistribute it and/or
87modify it under the same terms as Perl itself.
88
89See F<http://dev.perl.org/licenses/>
90
91=cut
92