Debian Codegraph @

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