fix(docs): update tolerance description in DbscanValidParams (#358)

Co-authored-by: Rémi Lafage <remi.lafage@onera.fr>
rust-ml · Jan 14, 2025 · f1f1938 · f1f1938
1 parent 606f59c
commit f1f1938
Showing 1 changed file with 1 addition and 1 deletion.
diff --git a/algorithms/linfa-clustering/src/dbscan/hyperparams.rs b/algorithms/linfa-clustering/src/dbscan/hyperparams.rs
@@ -82,7 +82,7 @@ impl<F: Float, D: Distance<F>, N: NearestNeighbour> ParamGuard for DbscanParams<
 impl<F: Float, D: Distance<F>, N: NearestNeighbour> TransformGuard for DbscanParams<F, D, N> {}
 
 impl<F: Float, D: Distance<F>, N: NearestNeighbour> DbscanValidParams<F, D, N> {
-    /// Nearest neighbour algorithm used for range queries
+    /// Maximum distance between two points to be considered neighbors
     pub fn tolerance(&self) -> F {
         self.tolerance
     }