clean up credo

adobe · May 16, 2024 · 4a0d416 · 4a0d416
1 parent 59d581d
commit 4a0d416
Showing 1 changed file with 0 additions and 13 deletions.
diff --git a/docs/credo.cheatmd b/docs/credo.cheatmd
@@ -15,43 +15,30 @@ Disabling the rules means updating your `.credo.exs` depending on your configura
 # Some of the rules have `priority: :high`, meaning Credo runs them unless we explicitly disable them
 # (removing them from this file wouldn't be enough, the `false` is required)
 #
-# Some rules have a comment before them explaining ways Styler deviates from the Credo rule.
-#
-# always expands `A.{B, C}`
 {Credo.Check.Consistency.MultiAliasImportRequireUse, false},
-# including `case`, `fn` and `with` statements
 {Credo.Check.Consistency.ParameterPatternMatching, false},
-# Styler implements this rule with a depth of 3 and minimum repetition of 2
 {Credo.Check.Design.AliasUsage, false},
 {Credo.Check.Readability.AliasOrder, false},
 {Credo.Check.Readability.BlockPipe, false},
-# goes further than formatter - fixes bad underscores, eg: `100_00` -> `10_000`
 {Credo.Check.Readability.LargeNumbers, false},
-# adds `@moduledoc false`
 {Credo.Check.Readability.ModuleDoc, false},
 {Credo.Check.Readability.MultiAlias, false},
 {Credo.Check.Readability.OneArityFunctionInPipe, false},
-# removes parens
 {Credo.Check.Readability.ParenthesesOnZeroArityDefs, false},
 {Credo.Check.Readability.PipeIntoAnonymousFunctions, false},
 {Credo.Check.Readability.PreferImplicitTry, false},
 {Credo.Check.Readability.SinglePipe, false},
-# **potentially breaks compilation** - see **Troubleshooting** section below
 {Credo.Check.Readability.StrictModuleLayout, false},
 {Credo.Check.Readability.StringSigils, false},
 {Credo.Check.Readability.UnnecessaryAliasExpansion, false},
 {Credo.Check.Readability.WithSingleClause, false},
 {Credo.Check.Refactor.CaseTrivialMatches, false},
 {Credo.Check.Refactor.CondStatements, false},
-# in pipes only
 {Credo.Check.Refactor.FilterCount, false},
-# in pipes only
 {Credo.Check.Refactor.MapInto, false},
-# in pipes only
 {Credo.Check.Refactor.MapJoin, false},
 {Credo.Check.Refactor.NegatedConditionsInUnless, false},
 {Credo.Check.Refactor.NegatedConditionsWithElse, false},
-# allows ecto's `from
 {Credo.Check.Refactor.PipeChainStart, false},
 {Credo.Check.Refactor.RedundantWithClauseResult, false},
 {Credo.Check.Refactor.UnlessWithElse, false},