Add documentation

solidusio · Nov 13, 2023 · 5f0196e · 5f0196e
1 parent 7be414d
commit 5f0196e
Show file tree

Hide file tree

Showing 2 changed files with 23 additions and 0 deletions.
diff --git a/docs/cops.md b/docs/cops.md
@@ -6,6 +6,7 @@ In the following section you find all available cops:
 #### Department [Solidus](cops_solidus.md)
 
 * [Solidus/ClassEvalDecorator](cops_solidus.md#solidusclassevaldecorator)
+* [Solidus/DiscountedAmountDeprecated](cops_solidus.md#solidusdiscountedamountdeprecated)
 * [Solidus/ExistingCardIdDeprecated](cops_solidus.md#solidusexistingcardiddeprecated)
 * [Solidus/ReimbursementHookDeprecated](cops_solidus.md#solidusreimbursementhookdeprecated)
 * [Solidus/SpreeCalculatorFreeShippingDeprecated](cops_solidus.md#solidusspreecalculatorfreeshippingdeprecated)

diff --git a/docs/cops_solidus.md b/docs/cops_solidus.md
@@ -32,6 +32,28 @@ end
 
 * [https://github.com/solidusio/rubocop-solidus/issues/21](https://github.com/solidusio/rubocop-solidus/issues/21)
 
+## Solidus/DiscountedAmountDeprecated
+
+Enabled by default | Safe | Supports autocorrection | VersionAdded | VersionChanged | Required Solidus Version
+--- | --- | --- | --- | --- | ---
+Enabled | Yes | No | 0.3 | - | 2.4
+
+This cop finds .discounted_amount occurrences and suggest using .total_before_tax instead.
+
+### Examples
+
+```ruby
+# bad
+line_item.discounted_amount
+
+# good
+line_item.total_before_tax
+```
+
+### References
+
+* [https://github.com/solidusio/rubocop-solidus/issues/31](https://github.com/solidusio/rubocop-solidus/issues/31)
+
 ## Solidus/ExistingCardIdDeprecated
 
 Enabled by default | Safe | Supports autocorrection | VersionAdded | VersionChanged | Required Solidus Version