Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

turf-transform-rotate/turf-ellipse: Fix documentation for angle parameter #2016

Merged
merged 1 commit into from
Jan 22, 2021
Merged

turf-transform-rotate/turf-ellipse: Fix documentation for angle parameter #2016

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion packages/turf-ellipse/index.js
View file
Open in desktop
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
View file
Open in desktop
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