Update auto-gen-config's auto-correction comments

This is a follow-up to 2ca25cd, following a suggestion from bbatsov in the code review.
rubocop · Feb 13, 2022 · 7143006 · 7143006
1 parent c0136af
commit 7143006
Show file tree

Hide file tree

Showing 4 changed files with 55 additions and 54 deletions.
diff --git a/changelog/change_auto_correct_message.md b/changelog/change_auto_correct_message.md
@@ -0,0 +1 @@
+* [#10414](https://github.com/rubocop/rubocop/pull/10414): Update auto-gen-config's auto-correction comments to be more clear. ([@maxjacobson][])
diff --git a/lib/rubocop/formatter/disabled_config_formatter.rb b/lib/rubocop/formatter/disabled_config_formatter.rb
@@ -124,9 +124,9 @@ def output_cop_comments(output_buffer, cfg, cop_name, offense_count)
         default_cfg = default_config(cop_name)
 
         if supports_safe_auto_correct?(cop_class, default_cfg)
-          output_buffer.puts '# Cop supports --auto-correct.'
+          output_buffer.puts '# This cop supports safe auto-correction (--auto-correct).'
         elsif supports_unsafe_autocorrect?(cop_class, default_cfg)
-          output_buffer.puts '# Cop supports --auto-correct-all.'
+          output_buffer.puts '# This cop supports unsafe auto-correction (--auto-correct-all).'
         end
 
         return unless default_cfg