Update the doc for Performance/FlatMap

richardstewart0213 · Mar 23, 2021 · 8ee8d3a · 8ee8d3a
1 parent 9b17953
commit 8ee8d3a
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 2 deletions.
diff --git a/docs/modules/ROOT/pages/cops_performance.adoc b/docs/modules/ROOT/pages/cops_performance.adoc
@@ -915,7 +915,8 @@ waldo.size
 | -
 |===
 
-This cop is used to identify usages of
+This cop is used to identify usages of `map { ... }.flatten` and
+change them to use `flat_map { ... }` instead.
 
 === Examples
 

diff --git a/lib/rubocop/cop/performance/flat_map.rb b/lib/rubocop/cop/performance/flat_map.rb
@@ -3,7 +3,8 @@
 module RuboCop
   module Cop
     module Performance
-      # This cop is used to identify usages of
+      # This cop is used to identify usages of `map { ... }.flatten` and
+      # change them to use `flat_map { ... }` instead.
       #
       # @example
       #   # bad