Add warning about shape distortion #217

Turfjs · Jan 29, 2025 · 0cfb7d2 · 0cfb7d2
1 parent 7ee0b1d
commit 0cfb7d2
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/packages/turf-transform-translate/index.ts b/packages/turf-transform-translate/index.ts
@@ -9,6 +9,9 @@ import { rhumbDestination } from "@turf/rhumb-destination";
  * Moves any geojson Feature or Geometry of a specified distance along a Rhumb Line
  * on the provided direction angle.
  *
+ * Note that this moves the points of your shape individually and can therefore change
+ * the overall shape. How noticable this is depends on the distance and the used projection.
+ *
  * @function
  * @param {GeoJSON|GeometryCollection} geojson object to be translated
  * @param {number} distance length of the motion; negative values determine motion in opposite direction