Skip to content

Commit

Permalink
Fix documentation for angle parameter in turf-transform-rotate and tu…
Browse files Browse the repository at this point in the history
…rf-ellipse (#2015) (#2016)
  • Loading branch information
pasieronen authored Jan 22, 2021
1 parent 57c8877 commit 304bdd9
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 4 deletions.
2 changes: 1 addition & 1 deletion packages/turf-ellipse/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ import { getCoord } from "@turf/invariant";
* @param {number} xSemiAxis semi (major) axis of the ellipse along the x-axis
* @param {number} ySemiAxis semi (minor) axis of the ellipse along the y-axis
* @param {Object} [options={}] Optional parameters
* @param {number} [options.angle=0] angle of rotation (along the vertical axis), from North in decimal degrees, negative clockwise
* @param {number} [options.angle=0] angle of rotation in decimal degrees, positive clockwise
* @param {Coord} [options.pivot='origin'] point around which the rotation will be performed
* @param {number} [options.steps=64] number of steps
* @param {string} [options.units='kilometers'] unit of measurement for axes
Expand Down
5 changes: 2 additions & 3 deletions packages/turf-transform-rotate/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,11 @@ import { getCoords } from "@turf/invariant";
import { isObject } from "@turf/helpers";

/**
* Rotates any geojson Feature or Geometry of a specified angle, around its `centroid` or a given `pivot` point;
* all rotations follow the right-hand rule: https://en.wikipedia.org/wiki/Right-hand_rule
* Rotates any geojson Feature or Geometry of a specified angle, around its `centroid` or a given `pivot` point.
*
* @name transformRotate
* @param {GeoJSON} geojson object to be rotated
* @param {number} angle of rotation (along the vertical axis), from North in decimal degrees, negative clockwise
* @param {number} angle of rotation in decimal degrees, positive clockwise
* @param {Object} [options={}] Optional parameters
* @param {Coord} [options.pivot='centroid'] point around which the rotation will be performed
* @param {boolean} [options.mutate=false] allows GeoJSON input to be mutated (significant performance increase if true)
Expand Down

0 comments on commit 304bdd9

Please sign in to comment.