changed doc example to showcase new default behavior

PicnicSupermarket · Oct 2, 2024 · 7fd5b74 · 7fd5b74
1 parent 1cd404d
commit 7fd5b74
Showing 1 changed file with 3 additions and 2 deletions.
diff --git a/docs/index.md b/docs/index.md
@@ -11,7 +11,7 @@ encourage) good practices.
 ## Example
 
 ```
-> dbt-score lint
+> dbt-score lint --show_all
 🥇 customers (score: 10.0)
     OK   dbt_score.rules.generic.has_description
     OK   dbt_score.rules.generic.has_owner: Model lacks an owner.
@@ -21,7 +21,8 @@ Score: 10.0 🥇
 
 In this example, the model `customers` scores the maximum value of `10.0` as it
 passes all the rules. It also is awarded a golden medal because of the perfect
-score.
+score. By default a passing model without rule violations will only be shown if
+we pass the `---show_all` flag.
 
 ## Philosophy