diff --git a/packages/turf-clusters-dbscan/README.md b/packages/turf-clusters-dbscan/README.md index 974d6af7c..2b4c8d107 100644 --- a/packages/turf-clusters-dbscan/README.md +++ b/packages/turf-clusters-dbscan/README.md @@ -9,7 +9,7 @@ Takes a set of [points][1] and partition them into clusters according to [https: ### Parameters * `points` **[FeatureCollection][3]<[Point][1]>** to be clustered -* `maxDistance` **[number][4]** Maximum Distance between any point of the cluster to generate the clusters (kilometers only) +* `maxDistance` **[number][4]** Maximum Distance between any point of the cluster to generate the clusters (kilometers by default, see options) * `options` **[Object][5]** Optional parameters (optional, default `{}`) * `options.units` **[string][6]** in which `maxDistance` is expressed, can be degrees, radians, miles, or kilometers (optional, default `"kilometers"`) diff --git a/packages/turf-clusters-dbscan/index.ts b/packages/turf-clusters-dbscan/index.ts index 7ad890620..fa89f4e8b 100644 --- a/packages/turf-clusters-dbscan/index.ts +++ b/packages/turf-clusters-dbscan/index.ts @@ -24,7 +24,7 @@ type IndexedPoint = { * * @name clustersDbscan * @param {FeatureCollection} points to be clustered - * @param {number} maxDistance Maximum Distance between any point of the cluster to generate the clusters (kilometers only) + * @param {number} maxDistance Maximum Distance between any point of the cluster to generate the clusters (kilometers by default, see options) * @param {Object} [options={}] Optional parameters * @param {string} [options.units="kilometers"] in which `maxDistance` is expressed, can be degrees, radians, miles, or kilometers * @param {boolean} [options.mutate=false] Allows GeoJSON input to be mutated