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

grevgeny · relf · web-flow · commit f1f1938d7308 · 2025-01-14T11:29:44.000+01:00
Co-authored-by: Rémi Lafage &lt;remi.lafage@onera.fr&gt;
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
     }

Original file line number	Diff line number	Diff line change
`@@ -82,7 +82,7 @@ impl<F: Float, D: Distance<F>, N: NearestNeighbour> ParamGuard for DbscanParams<`
`82`	`82`	`impl<F: Float, D: Distance<F>, N: NearestNeighbour> TransformGuard for DbscanParams<F, D, N> {}`
`83`	`83`
`84`	`84`	`impl<F: Float, D: Distance<F>, N: NearestNeighbour> DbscanValidParams<F, D, N> {`
`85`		`- /// Nearest neighbour algorithm used for range queries`
	`85`	`+ /// Maximum distance between two points to be considered neighbors`
`86`	`86`	`pub fn tolerance(&self) -> F {`
`87`	`87`	`self.tolerance`
`88`	`88`	`}`