Docs: clearer description for booleanOverlap (#2133)

Turfjs · Jun 28, 2021 · 630db1e · 630db1e
1 parent 4eab527
commit 630db1e
Showing 1 changed file with 2 additions and 0 deletions.
diff --git 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<LineString|MultiLineString|Polygon|MultiPolygon>} feature1 input
  * @param  {Geometry|Feature<LineString|MultiLineString|Polygon|MultiPolygon>} feature2 input