Skip to content

Commit ad8012c

Browse files
mwenkomfedderly
andauthored
chore: update cluster-dbscan docs (#2624)
Co-authored-by: Matt Fedderly <[email protected]>
1 parent 36cdb9f commit ad8012c

File tree

2 files changed

+2
-2
lines changed

2 files changed

+2
-2
lines changed

packages/turf-clusters-dbscan/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Takes a set of [points][1] and partition them into clusters according to [https:
99
### Parameters
1010

1111
* `points` **[FeatureCollection][3]<[Point][1]>** to be clustered
12-
* `maxDistance` **[number][4]** Maximum Distance between any point of the cluster to generate the clusters (kilometers only)
12+
* `maxDistance` **[number][4]** Maximum Distance between any point of the cluster to generate the clusters (kilometers by default, see options)
1313
* `options` **[Object][5]** Optional parameters (optional, default `{}`)
1414

1515
* `options.units` **[string][6]** in which `maxDistance` is expressed, can be degrees, radians, miles, or kilometers (optional, default `"kilometers"`)

packages/turf-clusters-dbscan/index.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ type IndexedPoint = {
2424
*
2525
* @name clustersDbscan
2626
* @param {FeatureCollection<Point>} points to be clustered
27-
* @param {number} maxDistance Maximum Distance between any point of the cluster to generate the clusters (kilometers only)
27+
* @param {number} maxDistance Maximum Distance between any point of the cluster to generate the clusters (kilometers by default, see options)
2828
* @param {Object} [options={}] Optional parameters
2929
* @param {string} [options.units="kilometers"] in which `maxDistance` is expressed, can be degrees, radians, miles, or kilometers
3030
* @param {boolean} [options.mutate=false] Allows GeoJSON input to be mutated

0 commit comments

Comments
 (0)