Skip to content

Commit 5b8492e

Browse files
committed
Clarify expectations of false positives/negatives (#27964)
Today this part of the documentation just says that Geo queries are not 100% accurate, but in fact we can be more precise about which kinds of queries see which kinds of error. This commit clarifies this point.
1 parent 467e867 commit 5b8492e

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

docs/reference/mapping/types/geo-shape.asciidoc

+6-6
Original file line numberDiff line numberDiff line change
@@ -143,12 +143,12 @@ are provided:
143143
[float]
144144
===== Accuracy
145145

146-
Geo_shape does not provide 100% accuracy and depending on how it is
147-
configured it may return some false positives or false negatives for
148-
certain queries. To mitigate this, it is important to select an
149-
appropriate value for the tree_levels parameter and to adjust
150-
expectations accordingly. For example, a point may be near the border of
151-
a particular grid cell and may thus not match a query that only matches the
146+
Geo_shape does not provide 100% accuracy and depending on how it is configured
147+
it may return some false positives for `INTERSECTS`, `WITHIN` and `CONTAINS`
148+
queries, and some false negatives for `DISJOINT` queries. To mitigate this, it
149+
is important to select an appropriate value for the tree_levels parameter and
150+
to adjust expectations accordingly. For example, a point may be near the border
151+
of a particular grid cell and may thus not match a query that only matches the
152152
cell right next to it -- even though the shape is very close to the point.
153153

154154
[float]

0 commit comments

Comments
 (0)