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

Chore: Update cluster-dbscan docs #2624

Merged
merged 2 commits into from
Aug 9, 2024
Merged

Chore: Update cluster-dbscan docs #2624

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9d788e0
chore: update cluster-dbscan docs
mwenko Jun 17, 2024
66551e2
Merge remote-tracking branch 'origin/master' into HEAD
mfedderly Aug 9, 2024
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-clusters-dbscan/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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"`)
Expand Down
2 changes: 1 addition & 1 deletion packages/turf-clusters-dbscan/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ type IndexedPoint = {
*
* @name clustersDbscan
* @param {FeatureCollection<Point>} 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
Expand Down