Login
Remove documentation about the -config option to P::C::new()
authorElliot Shank <perl@galumph.com>
Thu, 10 Jul 2008 21:47:28 +0000 (21:47 +0000)
committerElliot Shank <perl@galumph.com>
Thu, 10 Jul 2008 21:47:28 +0000 (21:47 +0000)
so that people won't start new code that depends upon it.

lib/Perl/Critic.pm

index 23c383b..b314dff 100644 (file)
@@ -465,8 +465,6 @@ URL and interface to the service are subject to change.
 
 =item C<< new( [ -profile => $FILE, -severity => $N, -theme => $string, -include => \@PATTERNS, -exclude => \@PATTERNS, -top => $N, -only => $B, -profile-strictness => $PROFILE_STRICTNESS_{WARN|FATAL|QUIET}, -force => $B, -verbose => $N ], -color => $B, -criticism-fatal => $B) >>
 
-=item C<< new( -config => Perl::Critic::Config->new() ) >>
-
 =item C<< new() >>
 
 Returns a reference to a new Perl::Critic object.  Most arguments are
@@ -599,12 +597,6 @@ of L<perlcritic|perlcritic>.
 B<-criticism-fatal> is not used by Perl::Critic but is provided for
 the benefit of L<criticism|criticism>.
 
-B<-config> is a reference to a
-L<Perl::Critic::Config|Perl::Critic::Config> object.  If you have
-created your own Config object for some reason, you can pass it in
-here instead of having Perl::Critic create one for you.  Using the
-C<-config> option causes all the other options to be silently ignored.
-
 =back