Skip to content

Commit c9a052f

Browse files
docs: point range_overlaps at the predicate it answers (#2881)
1 parent de2e90b commit c9a052f

1 file changed

Lines changed: 3 additions & 2 deletions

File tree

lib/ash/query/function/range_overlaps.ex

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,9 @@ defmodule Ash.Query.Function.RangeOverlaps do
66
@moduledoc """
77
Returns true if two ranges overlap (share at least one point).
88
9-
Maps to the Postgres range overlap operator `&&`. Used, among other things, to
10-
relate two temporal resources (`range_overlaps(parent(valid_at), valid_at)`).
9+
Maps to the Postgres range overlap operator `&&`, and answers in an expression what
10+
`Ash.Range.intersects?/2` answers at runtime. Used, among other things, to relate
11+
two temporal resources (`range_overlaps(parent(valid_at), valid_at)`).
1112
1213
range_overlaps(range1, range2)
1314
"""

0 commit comments

Comments
 (0)