.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Test2::EventFacet::Plan 3perl"
.TH Test2::EventFacet::Plan 3perl "2021-09-24" "perl v5.32.1" "Perl Programmers Reference Guide"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Test2::EventFacet::Plan \- Facet for setting the plan
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Events use this facet when they need to set the plan.
.SH "FIELDS"
.IX Header "FIELDS"
.ie n .IP "$string = $plan\->{details}" 4
.el .IP "\f(CW$string\fR = \f(CW$plan\fR\->{details}" 4
.IX Item "$string = $plan->{details}"
.PD 0
.ie n .IP "$string = $plan\->\fBdetails()\fR" 4
.el .IP "\f(CW$string\fR = \f(CW$plan\fR\->\fBdetails()\fR" 4
.IX Item "$string = $plan->details()"
.PD
Human readable explanation for the plan being set. This is normally not
rendered by most formatters except when the \f(CW\*(C`skip\*(C'\fR field is also set.
.ie n .IP "$positive_int = $plan\->{count}" 4
.el .IP "\f(CW$positive_int\fR = \f(CW$plan\fR\->{count}" 4
.IX Item "$positive_int = $plan->{count}"
.PD 0
.ie n .IP "$positive_int = $plan\->\fBcount()\fR" 4
.el .IP "\f(CW$positive_int\fR = \f(CW$plan\fR\->\fBcount()\fR" 4
.IX Item "$positive_int = $plan->count()"
.PD
Set the number of expected assertions. This should usually be set to \f(CW0\fR when
\&\f(CW\*(C`skip\*(C'\fR or \f(CW\*(C`none\*(C'\fR are also set.
.ie n .IP "$bool = $plan\->{skip}" 4
.el .IP "\f(CW$bool\fR = \f(CW$plan\fR\->{skip}" 4
.IX Item "$bool = $plan->{skip}"
.PD 0
.ie n .IP "$bool = $plan\->\fBskip()\fR" 4
.el .IP "\f(CW$bool\fR = \f(CW$plan\fR\->\fBskip()\fR" 4
.IX Item "$bool = $plan->skip()"
.PD
When true the entire test should be skipped. This is usually paired with an
explanation in the \f(CW\*(C`details\*(C'\fR field, and a \f(CW\*(C`control\*(C'\fR facet that has
\&\f(CW\*(C`terminate\*(C'\fR set to \f(CW0\fR.
.ie n .IP "$bool = $plan\->{none}" 4
.el .IP "\f(CW$bool\fR = \f(CW$plan\fR\->{none}" 4
.IX Item "$bool = $plan->{none}"
.PD 0
.ie n .IP "$bool = $plan\->\fBnone()\fR" 4
.el .IP "\f(CW$bool\fR = \f(CW$plan\fR\->\fBnone()\fR" 4
.IX Item "$bool = $plan->none()"
.PD
This is mainly used by legacy Test::Builder tests which set the plan to \f(CW\*(C`no
plan\*(C'\fR, a construct that predates the much better \f(CW\*(C`done_testing()\*(C'\fR.
.Sp
If you are using this in non-legacy code you may need to reconsider the course
of your life, maybe a hermitage would suite you?
.SH "SOURCE"
.IX Header "SOURCE"
The source code repository for Test2 can be found at
\&\fIhttp://github.com/Test\-More/test\-more/\fR.
.SH "MAINTAINERS"
.IX Header "MAINTAINERS"
.IP "Chad Granum <exodist@cpan.org>" 4
.IX Item "Chad Granum <exodist@cpan.org>"
.SH "AUTHORS"
.IX Header "AUTHORS"
.PD 0
.IP "Chad Granum <exodist@cpan.org>" 4
.IX Item "Chad Granum <exodist@cpan.org>"
.PD
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
Copyright 2019 Chad Granum <exodist@cpan.org>.
.PP
This program is free software; you can redistribute it and/or
modify it under the same terms as Perl itself.
.PP
See \fIhttp://dev.perl.org/licenses/\fR