Debian Codegraph @

upstream/mageia-cauldron/man3pm/Test2::Event::Ok.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::Event::Ok 3pm"
61 .TH Test2::Event::Ok 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::Event::Ok \- Ok event type
68 .SH DESCRIPTION
69 .IX Header "DESCRIPTION"
70 Ok events are generated whenever you run a test that produces a result.
71 Examples are \f(CWok()\fR, and \f(CWis()\fR.
72 .SH SYNOPSIS
73 .IX Header "SYNOPSIS"
74 .Vb 2
75 \& use Test2::API qw/context/;
76 \& use Test2::Event::Ok;
77 \&
78 \& my $ctx = context();
79 \& my $event = $ctx\->ok($bool, $name, \e@diag);
80 .Ve
81 .PP
82 or:
83 .PP
84 .Vb 6
85 \& my $ctx = context();
86 \& my $event = $ctx\->send_event(
87 \& \*(AqOk\*(Aq,
88 \& pass => $bool,
89 \& name => $name,
90 \& );
91 .Ve
92 .SH ACCESSORS
93 .IX Header "ACCESSORS"
94 .ie n .IP "$rb = $e\->pass" 4
95 .el .IP "\f(CW$rb\fR = \f(CW$e\fR\->pass" 4
96 .IX Item "$rb = $e->pass"
97 The original true/false value of whatever was passed into the event (but
98 reduced down to 1 or 0).
99 .ie n .IP "$name = $e\->name" 4
100 .el .IP "\f(CW$name\fR = \f(CW$e\fR\->name" 4
101 .IX Item "$name = $e->name"
102 Name of the test.
103 .ie n .IP "$b = $e\->effective_pass" 4
104 .el .IP "\f(CW$b\fR = \f(CW$e\fR\->effective_pass" 4
105 .IX Item "$b = $e->effective_pass"
106 This is the true/false value of the test after TODO and similar modifiers are
107 taken into account.
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/>