Debian Codegraph @

upstream/mageia-cauldron/man3pm/Test2::EventFacet::Info.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::Info 3pm"
61 .TH Test2::EventFacet::Info 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::Info \- Facet for information a developer might care about.
68 .SH DESCRIPTION
69 .IX Header "DESCRIPTION"
70 This facet represents messages intended for humans that will help them either
71 understand a result, or diagnose a failure.
72 .SH NOTES
73 .IX Header "NOTES"
74 This facet appears in a list instead of being a single item.
75 .SH FIELDS
76 .IX Header "FIELDS"
77 .ie n .IP "$string_or_structure = $info\->{details}" 4
78 .el .IP "\f(CW$string_or_structure\fR = \f(CW$info\fR\->{details}" 4
79 .IX Item "$string_or_structure = $info->{details}"
80 .PD 0
81 .ie n .IP "$string_or_structure = $info\->\fBdetails()\fR" 4
82 .el .IP "\f(CW$string_or_structure\fR = \f(CW$info\fR\->\fBdetails()\fR" 4
83 .IX Item "$string_or_structure = $info->details()"
84 .PD
85 Human readable string or data structure, this is the information to display.
86 Formatters are free to render the structures however they please. This may
87 contain a blessed object.
88 .Sp
89 If the \f(CW\*(C`table\*(C'\fR attribute (see below) is set then a renderer may choose to
90 display the table instead of the details.
91 .ie n .IP "$structure = $info\->{table}" 4
92 .el .IP "\f(CW$structure\fR = \f(CW$info\fR\->{table}" 4
93 .IX Item "$structure = $info->{table}"
94 .PD 0
95 .ie n .IP "$structure = $info\->\fBtable()\fR" 4
96 .el .IP "\f(CW$structure\fR = \f(CW$info\fR\->\fBtable()\fR" 4
97 .IX Item "$structure = $info->table()"
98 .PD
99 If the data the \f(CW\*(C`info\*(C'\fR facet needs to convey can be represented as a table
100 then the data may be placed in this attribute in a more raw form for better
101 display. The data must also be represented in the \f(CW\*(C`details\*(C'\fR attribute for
102 renderers which do not support rendering tables directly.
103 .Sp
104 The table structure:
105 .Sp
106 .Vb 2
107 \& my %table = {
108 \& header => [ \*(Aqcolumn 1 header\*(Aq, \*(Aqcolumn 2 header\*(Aq, ... ], # Optional
109 \&
110 \& rows => [
111 \& [\*(Aqrow 1 column 1\*(Aq, \*(Aqrow 1, column 2\*(Aq, ... ],
112 \& [\*(Aqrow 2 column 1\*(Aq, \*(Aqrow 2, column 2\*(Aq, ... ],
113 \& ...
114 \& ],
115 \&
116 \& # Allow the renderer to hide empty columns when true, Optional
117 \& collapse => $BOOL,
118 \&
119 \& # List by name or number columns that should never be collapsed
120 \& no_collapse => \e@LIST,
121 \& }
122 .Ve
123 .ie n .IP "$short_string = $info\->{tag}" 4
124 .el .IP "\f(CW$short_string\fR = \f(CW$info\fR\->{tag}" 4
125 .IX Item "$short_string = $info->{tag}"
126 .PD 0
127 .ie n .IP "$short_string = $info\->\fBtag()\fR" 4
128 .el .IP "\f(CW$short_string\fR = \f(CW$info\fR\->\fBtag()\fR" 4
129 .IX Item "$short_string = $info->tag()"
130 .PD
131 Short tag to categorize the info. This is usually 10 characters or less,
132 formatters may truncate longer tags.
133 .ie n .IP "$bool = $info\->{debug}" 4
134 .el .IP "\f(CW$bool\fR = \f(CW$info\fR\->{debug}" 4
135 .IX Item "$bool = $info->{debug}"
136 .PD 0
137 .ie n .IP "$bool = $info\->\fBdebug()\fR" 4
138 .el .IP "\f(CW$bool\fR = \f(CW$info\fR\->\fBdebug()\fR" 4
139 .IX Item "$bool = $info->debug()"
140 .PD
141 Set this to true if the message is critical, or explains a failure. This is
142 info that should be displayed by formatters even in less\-verbose modes.
143 .Sp
144 When false the information is not considered critical and may not be rendered
145 in less\-verbose modes.
146 .ie n .IP "$bool = $info\->{important}" 4
147 .el .IP "\f(CW$bool\fR = \f(CW$info\fR\->{important}" 4
148 .IX Item "$bool = $info->{important}"
149 .PD 0
150 .ie n .IP "$bool = $info\->important" 4
151 .el .IP "\f(CW$bool\fR = \f(CW$info\fR\->important" 4
152 .IX Item "$bool = $info->important"
153 .PD
154 This should be set for non debug messages that are still important enough to
155 show when a formatter is in quiet mode. A formatter should send these to STDOUT
156 not STDERR, but should show them even in non\-verbose mode.
157 .SH SOURCE
158 .IX Header "SOURCE"
159 The source code repository for Test2 can be found at
160 <https://github.com/Test\-More/test\-more/>.
161 .SH MAINTAINERS
162 .IX Header "MAINTAINERS"
163 .IP "Chad Granum <[email protected]>" 4
164 .IX Item "Chad Granum <[email protected]>"
165 .SH AUTHORS
166 .IX Header "AUTHORS"
167 .IP "Chad Granum <[email protected]>" 4
168 .IX Item "Chad Granum <[email protected]>"
169 .SH COPYRIGHT
170 .IX Header "COPYRIGHT"
171 Copyright Chad Granum <[email protected]>.
172 .PP
173 This program is free software; you can redistribute it and/or
174 modify it under the same terms as Perl itself.
175 .PP
176 See <https://dev.perl.org/licenses/>