suggested change

Co-authored-by: Andrew Valencik <valencik@users.noreply.github.com>
cozydev-pink · Oct 19, 2023 · 5f4f666 · 5f4f666
1 parent 7342edf
commit 5f4f666
Showing 1 changed file with 1 addition and 3 deletions.
diff --git a/core/src/main/scala/pink/cozydev/lucille/Query.scala b/core/src/main/scala/pink/cozydev/lucille/Query.scala
@@ -91,9 +91,7 @@ object Query {
     */
   final case class Proximity(str: String, num: Int) extends TermQuery
 
-  /** A fuzzy query
-    * Search for words within a Damerau-Levenshtein Distance
-    * The additional parameter, between 0 and 2, specifies the number of edits allowed (defaults to 2)
+  /** A fuzzy query with an optional distance value
     * e.g. 'cat~', 'cat~1'
     *
     * @param str the string