tweaks FzfDistance's docs

nomad · Nov 19, 2023 · b35d7c1 · b35d7c1
1 parent 8f5b832
commit b35d7c1
Showing 1 changed file with 3 additions and 1 deletion.
diff --git a/src/algos/fzf/distance.rs b/src/algos/fzf/distance.rs
@@ -2,7 +2,9 @@ use core::cmp::{Ord, PartialOrd};
 
 pub(super) type Score = i64;
 
-/// An opaque distance type returned by [`FzfV1`](super::FzfV1) and
+/// The fzf distance type.
+///
+/// This struct is returned by [`FzfV1`](super::FzfV1) and
 /// [`FzfV2`](super::FzfV2)'s [`Metric`](crate::Metric) implementations.
 #[derive(Debug, Clone, Copy, Eq, PartialEq)]
 pub struct FzfDistance(Score);