Merge pull request rubocop#144 from lucasocon/doc-big-decimal-with-nu…

…meric-argument Add bad example for BigDecimalWithNumericArgument
koic · Jul 7, 2020 · 809fae5 · 809fae5
2 parents c135880 + 797cbe0
commit 809fae5
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 12 deletions.
diff --git a/docs/modules/ROOT/pages/cops_performance.adoc b/docs/modules/ROOT/pages/cops_performance.adoc
@@ -46,18 +46,17 @@ This cop identifies places where numeric argument to BigDecimal should be
 converted to string. Initializing from String is faster
 than from Numeric for BigDecimal.
 
-BigDecimal(1, 2)
-BigDecimal(1.2, 3, exception: true)
-
-  # good
-BigDecimal('1', 2)
-BigDecimal('1.2', 3, exception: true)
-
 === Examples
 
 [source,ruby]
 ----
 # bad
+BigDecimal(1, 2)
+BigDecimal(1.2, 3, exception: true)
+
+# good
+BigDecimal('1', 2)
+BigDecimal('1.2', 3, exception: true)
 ----
 
 == Performance/BindCall

diff --git a/lib/rubocop/cop/performance/big_decimal_with_numeric_argument.rb b/lib/rubocop/cop/performance/big_decimal_with_numeric_argument.rb
@@ -8,14 +8,13 @@ module Performance
       # than from Numeric for BigDecimal.
       #
       # @example
-      #
       #   # bad
-      # BigDecimal(1, 2)
-      # BigDecimal(1.2, 3, exception: true)
+      #   BigDecimal(1, 2)
+      #   BigDecimal(1.2, 3, exception: true)
       #
       #   # good
-      # BigDecimal('1', 2)
-      # BigDecimal('1.2', 3, exception: true)
+      #   BigDecimal('1', 2)
+      #   BigDecimal('1.2', 3, exception: true)
       #
       class BigDecimalWithNumericArgument < Cop
         MSG = 'Convert numeric argument to string before passing to `BigDecimal`.'