Documentation: advise reading entire page first

scalameta · Apr 3, 2024 · 065054b · 065054b
1 parent 1a49732
commit 065054b
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/docs/configuration.md b/docs/configuration.md
@@ -3,6 +3,13 @@ id: configuration
 title: Configuration
 ---
 
+> If you have very specific preferences for configuring your formatting,
+> please make sure you have read this **entire** document, and identified every single
+> parameter available, along with their interactions.
+>
+> Many parameters do not have ultimate authority and might be overridden by
+> (possibly, default) values of other parameters.
+
 Configuration for scalafmt is defined in a plain text file `.scalafmt.conf`
 using [HOCON](https://github.com/lightbend/config) syntax.