Skip Menu |

Preferred bug tracker

Please visit the preferred bug tracker to report your issue.

This queue is for tickets about the Perl-Critic CPAN distribution.

Report information
The Basics
Id: 66017
Status: resolved
Priority: 0/
Queue: Perl-Critic
People
Owner: Nobody in particular
Requestors: xenoterracide [...] gmail.com
Cc:
AdminCc:
Bug Information
Severity: (no value)
Broken in: (no value)
Fixed in: 1.114

History Show all quoted text
  Mon Feb 21 21:24:42 2011 xenoterracide [...] gmail.com - Ticket created
Subject: severity description confusing
Date: Mon, 21 Feb 2011 20:24:32 -0600
To: bugs-perl-critic [...] rt.cpan.org
From: Caleb Cushing <xenoterracide [...] gmail.com>
severity is the level of importance you wish to assign to the Policy. All Policy modules are defined with a default severity value ranging from 1 (least severe) to 5 (most severe). However, you may disagree with the default severity and choose to give it a higher or lower severity, based on your own coding philosophy. You can set the severity to an integer from 1 to 5, or use one of the equivalent names: SEVERITY NAME ...is equivalent to... SEVERITY NUMBER ---------------------------------------------------- gentle 5 stern 4 harsh 3 cruel 2 brutal 1 ... so it says from 1 (least severe) to 5 (most severe) . but 1 is named brutal? and 5 is named gentle? that sounds like the exact opposite? is this all accurate? -- Caleb Cushing http://xenoterracide.com
  Mon Feb 21 21:48:43 2011 perl [...] galumph.com - Correspondence added
Subject: Re: [rt.cpan.org #66017] severity description confusing
Date: Mon, 21 Feb 2011 20:48:29 -0600
To: bug-Perl-Critic [...] rt.cpan.org
From: Elliot Shank <perl [...] galumph.com>
Yes, the whole severity level of P::C as a whole vs. that of an individual Policy is backwards. However, it's too late to fix now due to Policys outside of the P-C distribution and code which drives P::C other than perlcritic. Sorry.
  Mon Feb 21 21:48:44 2011 The RT System itself - Status changed from 'new' to 'open'
  Mon Feb 21 22:25:11 2011 xenoterracide [...] gmail.com - Correspondence added
Subject: Re: [rt.cpan.org #66017] severity description confusing
Date: Mon, 21 Feb 2011 21:25:02 -0600
To: bug-Perl-Critic [...] rt.cpan.org
From: Caleb Cushing <xenoterracide [...] gmail.com>
On Mon, Feb 21, 2011 at 8:48 PM, Elliot Shank via RT <bug-Perl-Critic@rt.cpan.org> wrote: Show quoted text
> Yes, the whole severity level of P::C as a whole vs. that of an individual Policy is backwards.  However, it's too late to fix now due to Policys outside of the P-C distribution and code which drives P::C other than perlcritic. > > Sorry.
you mean the way the docs can't be made to match the way it actually works? which seems to be 1 being the most severe. even though 1 beings most sever seems a little backwards... even if that's can't be changed (seems that's the way it works) due to backcompat, it would still seem like the docs could be changed to read only that way. -- Caleb Cushing http://xenoterracide.com
  Mon Feb 21 22:30:31 2011 wyant [...] cpan.org - Correspondence added
Yes, it is a bit counter-intuitive. I look at it this way: Numeric severity is how bad it is to violate a policy, ranging from 1 (picky, picky) to 5 (DANGER WILL ROBINSON!) The names describe how hard you want to criticize your code, from gently (only report the most severe violations) to brutally (report everything we know about).
  Mon Feb 21 22:43:53 2011 xenoterracide [...] gmail.com - Correspondence added
Subject: Re: [rt.cpan.org #66017] severity description confusing
Date: Mon, 21 Feb 2011 21:43:45 -0600
To: bug-Perl-Critic [...] rt.cpan.org
From: Caleb Cushing <xenoterracide [...] gmail.com>
On Mon, Feb 21, 2011 at 9:30 PM, Tom Wyant via RT <bug-Perl-Critic@rt.cpan.org> wrote: Show quoted text
> The names describe how hard you want to criticize your code, from gently > (only report the most severe violations) to brutally (report everything > we know about
I get that, but it seems to me that the docs could be worded better, as right now the table reads like one thing, while that paragraph description (at least to me) reads like it's the opposite. So what I'm suggesting is that the paragraph be rewritten to more closely match the table, and actual behavior, so as not to be confusing to a first time user (as I found it) -- Caleb Cushing http://xenoterracide.com
  Wed Feb 23 13:02:05 2011 wyant [...] cpan.org - Correspondence added
The table actually appears twice in the docs. I have inserted the following paragraph immediately below it both places: 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. This was committed as SVN revision 4043.
  Wed Feb 23 13:02:06 2011 wyant [...] cpan.org - Status changed from 'open' to 'patched'
  Fri Apr 01 17:19:01 2011 wyant [...] cpan.org - Status changed from 'patched' to 'resolved'
  Fri Apr 01 17:19:02 2011 wyant [...] cpan.org - Fixed in 1.114 added