Update code docs

mathieuprog · Jul 13, 2020 · 3279c50 · 3279c50
1 parent 21b8db8
commit 3279c50
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/lib/query_builder.ex b/lib/query_builder.ex
@@ -49,6 +49,12 @@ defmodule QueryBuilder do
   ```
   QueryBuilder.where(query, [role: :permissions], name@permissions: :write)
   ```
+
+  OR clauses may be passed through last argument `opts`. For example:
+
+  ```elixir
+  QueryBuilder.where(query, [], [firstname: "John"], or: [firstname: "Alice", lastname: "Doe"], or: [firstname: "Bob"])
+  ```
   """
   def where(query, assoc_fields, filters, opts \\ []) do
     ensure_query_has_binding(query)