Document Config#for_cop, #for_department [doc]

rubocop · Jul 14, 2020 · 3f0aab3 · 3f0aab3
1 parent 6b86210
commit 3f0aab3
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/lib/rubocop/config.rb b/lib/rubocop/config.rb
@@ -104,10 +104,14 @@ def deprecation_check
       end
     end
 
+    # @return [Config] for the given cop / cop name.
+    # Note: the 'Enabled' attribute is calculated according to the department's
+    # and 'AllCops' configuration; other attributes are not inherited.
     def for_cop(cop)
       @for_cop[cop.respond_to?(:cop_name) ? cop.cop_name : cop]
     end
 
+    # @return [Config] for the given department name.
     def for_department(department_name)
       @for_cop[department_name]
     end