.\" Automatically generated by Pod::Man 4.09 (Pod::Simple 3.35)
.\"
.\" 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
..
.if !\nF .nr F 0
.if \nF>0 \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    if !\nF==2 \{\
.        nr % 0
.        nr F 2
.    \}
.\}
.\" ========================================================================
.\"
.IX Title "Path::IsDev::Role::NegativeHeuristic 3pm"
.TH Path::IsDev::Role::NegativeHeuristic 3pm "2018-01-01" "perl v5.26.1" "User Contributed Perl Documentation"
.\" 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"
Path::IsDev::Role::NegativeHeuristic \- Base role for Negative Heuristic things.
.SH "VERSION"
.IX Header "VERSION"
version 1.001003
.SH "ROLE REQUIRES"
.IX Header "ROLE REQUIRES"
.ie n .SS """excludes"""
.el .SS "\f(CWexcludes\fP"
.IX Subsection "excludes"
Implementing classes must provide this method.
.PP
.Vb 3
\&    return : 1 / undef
\&             1     \-> this path is not a development directory as far as this heuristic is concerned
\&             undef \-> this path is a development directory as far as this heuristic is concerned
\&
\&    args : ( $class , $result_object )
\&        $class         \-> method will be invoked on packages, not objects
\&        $result_object \-> will be a Path::IsDev::Result
.Ve
.PP
Additionally, consuming classes \fBshould\fR set \f(CW\*(C`$result_object\->result( undef )\*(C'\fR prior to returning true.
.PP
Composing roles \fBshould\fR also invoke \f(CW\*(C`$result_object\->add_reason( $self, $result_value, $descriptive_reason_for_result, \e%contextinfo )\*(C'\fR.
.PP
See \f(CW\*(C`Path::IsDev::Result\*(C'\fR for details
.SH "METHODS"
.IX Header "METHODS"
.ie n .SS """name"""
.el .SS "\f(CWname\fP"
.IX Subsection "name"
Returns the name to use in debugging.
.PP
By default, this is derived from the classes name
with the \f(CW\*(C`PIDNH\*(C'\fR prefix removed:
.PP
.Vb 2
\&    Path::IsDev::NegativeHeuristic::IsDev::IgnoreFile\->name()
\&    → "\- ::IsDev::IgnoreFile"
.Ve
.ie n .SS """heuristic_type"""
.el .SS "\f(CWheuristic_type\fP"
.IX Subsection "heuristic_type"
Returns a description of the general heuristic type
.PP
.Vb 1
\&    negative heuristic
.Ve
.SH "AUTHOR"
.IX Header "AUTHOR"
Kent Fredric <kentnl@cpan.org>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
This software is copyright (c) 2017 by Kent Fredric <kentfredric@gmail.com>.
.PP
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.