Login
RT #66017 (severity description confusing)
authorTom Wyant <harryfmudd@comcast.net>
Wed, 23 Feb 2011 18:01:52 +0000 (18:01 +0000)
committerTom Wyant <harryfmudd@comcast.net>
Wed, 23 Feb 2011 18:01:52 +0000 (18:01 +0000)
Inserted a paragraph just below both severity name-to-number tables
attempting to clarify the fact the (e.g.) severity 5 (the worst) is
called 'gentle'.

Changes
lib/Perl/Critic.pm

diff --git a/Changes b/Changes
index 9f94122..0c9e5b0 100644 (file)
--- a/Changes
+++ b/Changes
@@ -3,6 +3,8 @@ A future release
     Policy Changes:
     * Documentation::RequirePodLinksIncludeText now handles nested POD
       formatting. RT #65569
+    * Clarified relation of severity numbers to names in Perl::Critic
+      POD. RT #66017
 
 [1.113] Released on 2011-02-14
 
index 8270d19..7100694 100644 (file)
@@ -337,6 +337,10 @@ values:
     -severity => 'cruel'                      -severity => 2
     -severity => 'brutal'                     -severity => 1
 
+The names reflect how severely the code is criticized: a C<gentle>
+criticism reports only the most severe violations, and so on down to a
+C<brutal> criticism which reports even the most minor violations.
+
 B<-theme> is special expression that determines which Policies to
 apply based on their respective themes.  For example, the following
 would load only Policies that have a 'bugs' AND 'pbp' theme:
@@ -595,6 +599,10 @@ names:
     cruel                                              2
     brutal                                             1
 
+The names reflect how severely the code is criticized: a C<gentle>
+criticism reports only the most severe violations, and so on down to a
+C<brutal> criticism which reports even the most minor violations.
+
 C<set_themes> sets the theme for the Policy and overrides its default
 theme.  The argument is a string of one or more whitespace-delimited
 alphanumeric words.  Themes are case-insensitive.  See L<"POLICY