Document class Cop::Team [doc]

rubocop · May 26, 2020 · c7a4e54 · c7a4e54
1 parent aa930ec
commit c7a4e54
Showing 1 changed file with 7 additions and 1 deletion.
diff --git a/lib/rubocop/cop/team.rb b/lib/rubocop/cop/team.rb
@@ -2,7 +2,13 @@
 
 module RuboCop
   module Cop
-    # FIXME
+    # A group of cops, ready to be called on duty to inspect files.
+    # Team is responsible for selecting only relevant cops to be sent on duty,
+    # as well as insuring that the needed forces are sent along with them.
+    #
+    # For performance reasons, Team will first dispatch cops & forces in two groups,
+    # first the ones needed for autocorrection (if any), then the rest
+    # (unless autocorrections happened).
     class Team
       DEFAULT_OPTIONS = {
         auto_correct: false,