Debian Codegraph @

upstream/mageia-cauldron/man3pm/Test2::EventFacet::Amnesty.3pm

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man v6.0.2 (Pod::Simple 3.45)
3 .\"
4 .\" Standard preamble:
5 .\" ========================================================================
6 .de Sp \" Vertical space (when we can't use .PP)
7 .if t .sp .5v
8 .if n .sp
9 ..
10 .de Vb \" Begin verbatim text
11 .ft CW
12 .nf
13 .ne \\$1
14 ..
15 .de Ve \" End verbatim text
16 .ft R
17 .fi
18 ..
19 .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
20 .ie n \{\
21 . ds C` ""
22 . ds C' ""
23 'br\}
24 .el\{\
25 . ds C`
26 . ds C'
27 'br\}
28 .\"
29 .\" Escape single quotes in literal strings from groff's Unicode transform.
30 .ie \n(.g .ds Aq \(aq
31 .el .ds Aq '
32 .\"
33 .\" If the F register is >0, we'll generate index entries on stderr for
34 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
35 .\" entries marked with X<> in POD. Of course, you'll have to process the
36 .\" output yourself in some meaningful fashion.
37 .\"
38 .\" Avoid warning from groff about undefined register 'F'.
39 .de IX
40 ..
41 .nr rF 0
42 .if \n(.g .if rF .nr rF 1
43 .if (\n(rF:(\n(.g==0)) \{\
44 . if \nF \{\
45 . de IX
46 . tm Index:\\$1\t\\n%\t"\\$2"
47 ..
48 . if !\nF==2 \{\
49 . nr % 0
50 . nr F 2
51 . \}
52 . \}
53 .\}
54 .rr rF
55 .\"
56 .\" Required to disable full justification in groff 1.23.0.
57 .if n .ds AD l
58 .\" ========================================================================
59 .\"
60 .IX Title "Test2::EventFacet::Amnesty 3pm"
61 .TH Test2::EventFacet::Amnesty 3pm 2025-06-24 "perl v5.42.0" "Perl Programmers Reference Guide"
62 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
63 .\" way too many mistakes in technical documents.
64 .if n .ad l
65 .nh
66 .SH NAME
67 Test2::EventFacet::Amnesty \- Facet for assertion amnesty.
68 .SH DESCRIPTION
69 .IX Header "DESCRIPTION"
70 This package represents what is expected in units of amnesty.
71 .SH NOTES
72 .IX Header "NOTES"
73 This facet appears in a list instead of being a single item.
74 .SH FIELDS
75 .IX Header "FIELDS"
76 .ie n .IP "$string = $amnesty\->{details}" 4
77 .el .IP "\f(CW$string\fR = \f(CW$amnesty\fR\->{details}" 4
78 .IX Item "$string = $amnesty->{details}"
79 .PD 0
80 .ie n .IP "$string = $amnesty\->\fBdetails()\fR" 4
81 .el .IP "\f(CW$string\fR = \f(CW$amnesty\fR\->\fBdetails()\fR" 4
82 .IX Item "$string = $amnesty->details()"
83 .PD
84 Human readable explanation of why amnesty was granted.
85 .Sp
86 Example: \fINot implemented yet, will fix\fR
87 .ie n .IP "$short_string = $amnesty\->{tag}" 4
88 .el .IP "\f(CW$short_string\fR = \f(CW$amnesty\fR\->{tag}" 4
89 .IX Item "$short_string = $amnesty->{tag}"
90 .PD 0
91 .ie n .IP "$short_string = $amnesty\->\fBtag()\fR" 4
92 .el .IP "\f(CW$short_string\fR = \f(CW$amnesty\fR\->\fBtag()\fR" 4
93 .IX Item "$short_string = $amnesty->tag()"
94 .PD
95 Short string (usually 10 characters or less, not enforced, but may be truncated
96 by renderers) categorizing the amnesty.
97 .ie n .IP "$bool = $amnesty\->{inherited}" 4
98 .el .IP "\f(CW$bool\fR = \f(CW$amnesty\fR\->{inherited}" 4
99 .IX Item "$bool = $amnesty->{inherited}"
100 .PD 0
101 .ie n .IP "$bool = $amnesty\->\fBinherited()\fR" 4
102 .el .IP "\f(CW$bool\fR = \f(CW$amnesty\fR\->\fBinherited()\fR" 4
103 .IX Item "$bool = $amnesty->inherited()"
104 .PD
105 This will be true if the amnesty was granted to a parent event and inherited by
106 this event, which is a child, such as an assertion within a subtest that is
107 marked todo.
108 .SH SOURCE
109 .IX Header "SOURCE"
110 The source code repository for Test2 can be found at
111 <https://github.com/Test\-More/test\-more/>.
112 .SH MAINTAINERS
113 .IX Header "MAINTAINERS"
114 .IP "Chad Granum <[email protected]>" 4
115 .IX Item "Chad Granum <[email protected]>"
116 .SH AUTHORS
117 .IX Header "AUTHORS"
118 .IP "Chad Granum <[email protected]>" 4
119 .IX Item "Chad Granum <[email protected]>"
120 .SH COPYRIGHT
121 .IX Header "COPYRIGHT"
122 Copyright Chad Granum <[email protected]>.
123 .PP
124 This program is free software; you can redistribute it and/or
125 modify it under the same terms as Perl itself.
126 .PP
127 See <https://dev.perl.org/licenses/>