From de6e4eec5b2a59ea6c18b17388eb21159752d5ac Mon Sep 17 00:00:00 2001 From: Derick M <58572875+TurtIeSocks@users.noreply.github.com> Date: Fri, 27 Oct 2023 00:18:38 -0400 Subject: [PATCH] docs --- docs/pages/api-reference/body.mdx | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/docs/pages/api-reference/body.mdx b/docs/pages/api-reference/body.mdx index d5955649..9a480d55 100644 --- a/docs/pages/api-reference/body.mdx +++ b/docs/pages/api-reference/body.mdx @@ -56,8 +56,11 @@ pub enum ReturnType { // Sort by types, only valid when clustering in non-fast mode: pub enum SortBy { - GeoHash, // default, sorts by geohash, fastest alternative to okay routing + None, // default, sorts by whatever the clustering algorithm returns + GeoHash, // sorts by geohash, fastest alternative to okay routing ClusterCount, // sorts by the number of data points in each cluster + S2Cell, // sorts by S2 Cell IDs + TSP, // sorts with OR-Tools (best) Random, // randomizes the order of the clusters } @@ -108,6 +111,10 @@ pub struct Args { /// /// Deprecated pub devices: Option, + /// The maximum amount of clusters to return + /// + /// Default: [USIZE::MAX] + pub max_clusters: Option, /// Whether to use the fast or slow clustering algorithm /// /// Default: `true`