Debian Codegraph @

upstream/debian-unstable/man3/Test2::EventFacet::Amnesty.3perl

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man 5.0102 (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 .\"
57 .IX Title "Test2::EventFacet::Amnesty 3perl"
58 .TH Test2::EventFacet::Amnesty 3perl 2025-11-16 "perl v5.40.1" "Perl Programmers Reference Guide"
59 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
60 .\" way too many mistakes in technical documents.
61 .if n .ad l
62 .nh
63 .SH NAME
64 Test2::EventFacet::Amnesty \- Facet for assertion amnesty.
65 .SH DESCRIPTION
66 .IX Header "DESCRIPTION"
67 This package represents what is expected in units of amnesty.
68 .SH NOTES
69 .IX Header "NOTES"
70 This facet appears in a list instead of being a single item.
71 .SH FIELDS
72 .IX Header "FIELDS"
73 .ie n .IP "$string = $amnesty\->{details}" 4
74 .el .IP "\f(CW$string\fR = \f(CW$amnesty\fR\->{details}" 4
75 .IX Item "$string = $amnesty->{details}"
76 .PD 0
77 .ie n .IP "$string = $amnesty\->\fBdetails()\fR" 4
78 .el .IP "\f(CW$string\fR = \f(CW$amnesty\fR\->\fBdetails()\fR" 4
79 .IX Item "$string = $amnesty->details()"
80 .PD
81 Human readable explanation of why amnesty was granted.
82 .Sp
83 Example: \fINot implemented yet, will fix\fR
84 .ie n .IP "$short_string = $amnesty\->{tag}" 4
85 .el .IP "\f(CW$short_string\fR = \f(CW$amnesty\fR\->{tag}" 4
86 .IX Item "$short_string = $amnesty->{tag}"
87 .PD 0
88 .ie n .IP "$short_string = $amnesty\->\fBtag()\fR" 4
89 .el .IP "\f(CW$short_string\fR = \f(CW$amnesty\fR\->\fBtag()\fR" 4
90 .IX Item "$short_string = $amnesty->tag()"
91 .PD
92 Short string (usually 10 characters or less, not enforced, but may be truncated
93 by renderers) categorizing the amnesty.
94 .ie n .IP "$bool = $amnesty\->{inherited}" 4
95 .el .IP "\f(CW$bool\fR = \f(CW$amnesty\fR\->{inherited}" 4
96 .IX Item "$bool = $amnesty->{inherited}"
97 .PD 0
98 .ie n .IP "$bool = $amnesty\->\fBinherited()\fR" 4
99 .el .IP "\f(CW$bool\fR = \f(CW$amnesty\fR\->\fBinherited()\fR" 4
100 .IX Item "$bool = $amnesty->inherited()"
101 .PD
102 This will be true if the amnesty was granted to a parent event and inherited by
103 this event, which is a child, such as an assertion within a subtest that is
104 marked todo.
105 .SH SOURCE
106 .IX Header "SOURCE"
107 The source code repository for Test2 can be found at
108 <https://github.com/Test\-More/test\-more/>.
109 .SH MAINTAINERS
110 .IX Header "MAINTAINERS"
111 .IP "Chad Granum <[email protected]>" 4
112 .IX Item "Chad Granum <[email protected]>"
113 .SH AUTHORS
114 .IX Header "AUTHORS"
115 .PD 0
116 .IP "Chad Granum <[email protected]>" 4
117 .IX Item "Chad Granum <[email protected]>"
118 .PD
119 .SH COPYRIGHT
120 .IX Header "COPYRIGHT"
121 Copyright 2020 Chad Granum <[email protected]>.
122 .PP
123 This program is free software; you can redistribute it and/or
124 modify it under the same terms as Perl itself.
125 .PP
126 See <https://dev.perl.org/licenses/>