Add doc for disabling comment style

rubocop · May 21, 2020 · 119d695 · 119d695
1 parent 82ded12
commit 119d695
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/manual/configuration.md b/manual/configuration.md
@@ -629,6 +629,12 @@ Running `rubocop --[safe-]auto-correct --disable-uncorrectable` will
 create comments to disable all offenses that can't be automatically
 corrected.
 
+Do not write anything other than cop name in the disabling comment. E.g.:
+
+```ruby
+# rubocop:disable Layout/LineLength --This is a bad comment that includes other than cop name.
+```
+
 ## Setting the style guide URL
 
 You can specify the base URL of the style guide using `StyleGuideBaseURL`.