From 630db1e354f7b3df376b7d1d0c3ffca3fdf49b80 Mon Sep 17 00:00:00 2001 From: Patrick Brett Date: Tue, 29 Jun 2021 05:53:24 +1000 Subject: [PATCH] Docs: clearer description for booleanOverlap (#2133) --- packages/turf-boolean-overlap/index.ts | 2 ++ 1 file changed, 2 insertions(+) diff --git a/packages/turf-boolean-overlap/index.ts b/packages/turf-boolean-overlap/index.ts index 648727bf27..948db9cc70 100644 --- a/packages/turf-boolean-overlap/index.ts +++ b/packages/turf-boolean-overlap/index.ts @@ -10,6 +10,8 @@ import { Feature, Geometry, MultiPoint } from "@turf/helpers"; * different from both but of the same dimension. It applies to Polygon/Polygon, LineString/LineString, * Multipoint/Multipoint, MultiLineString/MultiLineString and MultiPolygon/MultiPolygon. * + * In other words, it returns true if the two geometries overlap, provided that neither completely contains the other. + * * @name booleanOverlap * @param {Geometry|Feature} feature1 input * @param {Geometry|Feature} feature2 input