Merge pull request #2097 from scalacenter/settings-wildcard-cli

docs: tweak syntax to be shell-compliant
scalacenter · Oct 4, 2024 · 1bf297d · 1bf297d
2 parents 77f46da + 36f1874
commit 1bf297d
Showing 1 changed file with 3 additions and 3 deletions.
diff --git a/docs/users/configuration.md b/docs/users/configuration.md
@@ -117,11 +117,11 @@ lint.error.includes = ".*"
 lint.error.excludes = "UnusedScalafixSuppression"
 ```
 
-is equivalent to the following CLI arguments
+is equivalent to the following CLI arguments (note the escaped wildcard)
 
 ```
-scalafix ... \
+$ scalafix ... \
  --settings.DisableSyntax.noFinalize=true \
- --settings.lint.error.includes=.* \
+ --settings.lint.error.includes=.\* \
  --settings.lint.error.excludes=UnusedScalafixSuppression
 ```