Fix docs for Offense.cop_name

Earlopain · Earlopain · commit faaa34927f12 · 2024-10-30T09:45:58.000+01:00
It says the string will be without department, but that is not true.
diff --git a/lib/rubocop/cop/offense.rb b/lib/rubocop/cop/offense.rb
@@ -43,11 +43,10 @@ class Offense
       # @!attribute [r] cop_name
       #
       # @return [String]
-      #   a cop class name without department.
-      #   i.e. type of the violation.
+      #   the cop name as a String for which this offense is for.
       #
       # @example
-      #   'LineLength'
+      #   'Layout/LineLength'
       attr_reader :cop_name
 
       # @api private

Original file line number	Diff line number	Diff line change
`@@ -43,11 +43,10 @@ class Offense`
`43`	`43`	`# @!attribute [r] cop_name`
`44`	`44`	`#`
`45`	`45`	`# @return [String]`
`46`		`- # a cop class name without department.`
`47`		`- # i.e. type of the violation.`
	`46`	`+ # the cop name as a String for which this offense is for.`
`48`	`47`	`#`
`49`	`48`	`# @example`
`50`		`- # 'LineLength'`
	`49`	`+ # 'Layout/LineLength'`
`51`	`50`	`attr_reader :cop_name`
`52`	`51`
`53`	`52`	`# @api private`