Skip to content

Commit

Permalink
Clarifying what the "steps" param means in the documentation. Haven't…
Browse files Browse the repository at this point in the history
… rebuilt the readme as generate-readmes needs some work. Will make that a seperate PR though.
  • Loading branch information
smallsaucepan committed Nov 2, 2023
1 parent 1b06ef0 commit 25b5cb3
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion packages/turf-line-arc/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ import { Coord, lineString, Units } from "@turf/helpers";
* @param {number} bearing1 angle, in decimal degrees, of the first radius of the arc
* @param {number} bearing2 angle, in decimal degrees, of the second radius of the arc
* @param {Object} [options={}] Optional parameters
* @param {number} [options.steps=64] number of steps
* @param {number} [options.steps=64] number of steps (straight segments) that will constitute the arc
* @param {string} [options.units='kilometers'] miles, kilometers, degrees, or radians
* @returns {Feature<LineString>} line arc
* @example
Expand Down

0 comments on commit 25b5cb3

Please sign in to comment.