Basic doc for PPB

[gitmo/Perl-Critic-Dynamic-Moose.git] / lib / Perl / Critic / Policy / DynamicMoose / ProhibitPublicBuilders.pm

diff --git a/lib/Perl/Critic/Policy/DynamicMoose/ProhibitPublicBuilders.pm b/lib/Perl/Critic/Policy/DynamicMoose/ProhibitPublicBuilders.pm
index 7322bb2..69fa757 100644 (file)
--- a/lib/Perl/Critic/Policy/DynamicMoose/ProhibitPublicBuilders.pm
+++ b/lib/Perl/Critic/Policy/DynamicMoose/ProhibitPublicBuilders.pm
@@ -2,9 +2,11 @@ package Perl::Critic::Policy::DynamicMoose::ProhibitPublicBuilders;
 use Moose;
 extends 'Perl::Critic::Policy::DynamicMoose';
 
+use Perl::Critic::Utils ':severities';
 use Perl::Critic::Utils::Moose 'meta_type';
 
 Readonly::Scalar my $EXPL => q{Prefix builder method names with an underscore};
+sub default_severity { $SEVERITY_MEDIUM }
 
 augment applies_to_metaclass => sub { 'Moose::Meta::Role' };
 
@@ -45,3 +47,19 @@ no Moose;
 
 1;
 
+__END__
+
+=head1 NAME
+
+Perl::Critic::Policy::DynamicMoose::ProhibitPublicBuilders
+
+=head1 DESCRIPTION
+
+An attribute's L<Moose/builder> method is used to provide a default value
+for that attribute. Such methods are rarely intended for external use, and
+should not be considered part of that class's public API. Thus we recommend
+that your attribute builder methods' names are prefixed with an underscore
+to mark them private.
+
+=cut
+