Document interaction of Style/AccessorGrouping and Sorbet [doc]

See #8241 (comment)
rubocop · Oct 1, 2020 · dab9cde · dab9cde
1 parent f845314
commit dab9cde
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 0 deletions.
diff --git a/docs/modules/ROOT/pages/cops_style.adoc b/docs/modules/ROOT/pages/cops_style.adoc
@@ -120,6 +120,9 @@ This cop checks for grouping of accessors in `class` and `module` bodies.
 By default it enforces accessors to be placed in grouped declarations,
 but it can be configured to enforce separating them in multiple declarations.
 
+Note: `Sorbet` is not compatible with "grouped" style. Consider "separated" style
+or disabling this cop.
+
 === Examples
 
 ==== EnforcedStyle: grouped (default)

diff --git a/lib/rubocop/cop/style/accessor_grouping.rb b/lib/rubocop/cop/style/accessor_grouping.rb
@@ -7,6 +7,9 @@ module Style
       # By default it enforces accessors to be placed in grouped declarations,
       # but it can be configured to enforce separating them in multiple declarations.
       #
+      # Note: `Sorbet` is not compatible with "grouped" style. Consider "separated" style
+      # or disabling this cop.
+      #
       # @example EnforcedStyle: grouped (default)
       #   # bad
       #   class Foo