Merge pull request rubocop#9397 from Bhacaz/doc_supported_types

Add documentation for Layout/MultilineAssignmentLayout `SupportedTypes`
dvandersluis · Feb 5, 2021 · 21b6bfb · 21b6bfb
2 parents edef5e2 + 86e5a2b
commit 21b6bfb
Showing 1 changed file with 26 additions and 0 deletions.
diff --git a/lib/rubocop/cop/layout/multiline_assignment_layout.rb b/lib/rubocop/cop/layout/multiline_assignment_layout.rb
@@ -31,6 +31,32 @@ module Layout
       #   foo = if expression
       #     'bar'
       #   end
+      #
+      # @example SupportedTypes: ['block', 'case', 'class', 'if', 'kwbegin', 'module'] (default)
+      #   # good
+      #   foo =
+      #     if expression
+      #       'bar'
+      #     end
+      #
+      #   # good
+      #   foo =
+      #     [1].map do |i|
+      #       i + 1
+      #     end
+      #
+      # @example SupportedTypes: ['block']
+      #   # good
+      #   foo = if expression
+      #     'bar'
+      #   end
+      #
+      #   # good
+      #   foo =
+      #     [1].map do |i|
+      #       'bar' * i
+      #     end
+      #
       class MultilineAssignmentLayout < Base
         include CheckAssignment
         include ConfigurableEnforcedStyle