Added example to docs, updated test case, closes #35

cozydev-pink · Mar 24, 2024 · 4915e61 · 4915e61
1 parent 004eb97
commit 4915e61
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 2 deletions.
diff --git a/core/src/test/scala/pink/cozydev/protosearch/FrequencyIndexSearcherSuite.scala b/core/src/test/scala/pink/cozydev/protosearch/FrequencyIndexSearcherSuite.scala
@@ -125,8 +125,8 @@ class FrequencyIndexSearcherSuite extends munit.FunSuite {
   }
 
   test("regex") {
-    val q = search("/a(c|l)/")
-    val results = Set(1, 2)
+    val q = search("/jump.*/ /cat/")
+    val results = Set(0, 1, 2)
     assertEquals(
       q,
       Right(results)

diff --git a/docs/queries.md b/docs/queries.md
@@ -135,3 +135,12 @@ Additionally, field queries can take more complex boolean queries if specified i
 ```scala mdoc
 search("author:([b TO e] AND NOT dr*)")
 ```
+
+## Regex Query
+
+Regex queries allow for greater query flexibility by utilizing powerful regular expressions.
+
+```scala mdoc
+search("/jump.*")
+```
+