Debian Codegraph @

upstream/mageia-cauldron/man3pm/Test2::Event::Skip.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::Skip 3pm"
61 .TH Test2::Event::Skip 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::Skip \- Skip event type
68 .SH DESCRIPTION
69 .IX Header "DESCRIPTION"
70 Skip events bump test counts just like Test2::Event::Ok events, but
71 they can never fail.
72 .SH SYNOPSIS
73 .IX Header "SYNOPSIS"
74 .Vb 2
75 \& use Test2::API qw/context/;
76 \& use Test2::Event::Skip;
77 \&
78 \& my $ctx = context();
79 \& my $event = $ctx\->skip($name, $reason);
80 .Ve
81 .PP
82 or:
83 .PP
84 .Vb 6
85 \& my $ctx = context();
86 \& my $event = $ctx\->send_event(
87 \& \*(AqSkip\*(Aq,
88 \& name => $name,
89 \& reason => $reason,
90 \& );
91 .Ve
92 .SH ACCESSORS
93 .IX Header "ACCESSORS"
94 .ie n .IP "$reason = $e\->reason" 4
95 .el .IP "\f(CW$reason\fR = \f(CW$e\fR\->reason" 4
96 .IX Item "$reason = $e->reason"
97 The original true/false value of whatever was passed into the event (but
98 reduced down to 1 or 0).
99 .SH SOURCE
100 .IX Header "SOURCE"
101 The source code repository for Test2 can be found at
102 <https://github.com/Test\-More/test\-more/>.
103 .SH MAINTAINERS
104 .IX Header "MAINTAINERS"
105 .IP "Chad Granum <[email protected]>" 4
106 .IX Item "Chad Granum <[email protected]>"
107 .SH AUTHORS
108 .IX Header "AUTHORS"
109 .IP "Chad Granum <[email protected]>" 4
110 .IX Item "Chad Granum <[email protected]>"
111 .SH COPYRIGHT
112 .IX Header "COPYRIGHT"
113 Copyright Chad Granum <[email protected]>.
114 .PP
115 This program is free software; you can redistribute it and/or
116 modify it under the same terms as Perl itself.
117 .PP
118 See <https://dev.perl.org/licenses/>