Add section on printing boosts with precision

cozydev-pink · May 16, 2024 · 4b77e11 · 4b77e11
1 parent e7de3c2
commit 4b77e11
Showing 1 changed file with 12 additions and 0 deletions.
diff --git a/docs/index.md b/docs/index.md
@@ -40,6 +40,18 @@ import pink.cozydev.lucille.QueryPrinter
 QueryPrinter.print(Query.And(Query.Term("cats"), Query.Term("dogs")))
 ```
 
+Because the numeric value of a query boost parameter is modelled as a `Float`, the query printer
+has a `precision` parameter it uses to round the boost parameter for pretty printing:
+
+```scala mdoc
+val queryWithBoost = Query.Boost(Query.Phrase("apple pi"), 3.14159265f)
+
+// the default precision is 2
+QueryPrinter.print(queryWithBoost)
+
+QueryPrinter.print(queryWithBoost, precision=5)
+```
+
 ### Last Query Rewriting
 
 To enable a better interactive search experience, it can be helpful to rewrite the last term as a