From e157f1f8c2a6acd2374f165a41d5327f285ce91e Mon Sep 17 00:00:00 2001 From: Karl Wright Date: Fri, 25 Aug 2017 11:42:29 -0400 Subject: [PATCH] LUCENE-7941: Clarify contract for intersects() method. --- .../src/java/org/apache/lucene/spatial3d/geom/GeoShape.java | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/lucene/spatial3d/src/java/org/apache/lucene/spatial3d/geom/GeoShape.java b/lucene/spatial3d/src/java/org/apache/lucene/spatial3d/geom/GeoShape.java index 98283cdac70..bc2d8f9743a 100755 --- a/lucene/spatial3d/src/java/org/apache/lucene/spatial3d/geom/GeoShape.java +++ b/lucene/spatial3d/src/java/org/apache/lucene/spatial3d/geom/GeoShape.java @@ -35,7 +35,8 @@ public interface GeoShape extends Membership, PlanetObject { /** * Assess whether a plane, within the provided bounds, intersects - * with the shape. Note well that this method is allowed to return "true" + * with the shape's edges. Any overlap, even a single point, is considered to be an + * intersection. Note well that this method is allowed to return "true" * if there are internal edges of a composite shape which intersect the plane. * Doing this can cause getRelationship() for most GeoBBox shapes to return * OVERLAPS rather than the more correct CONTAINS, but that cannot be