From b35d7c1c7b7e065326ceaf001d8928733b7d6115 Mon Sep 17 00:00:00 2001 From: Riccardo Mazzarini Date: Sun, 19 Nov 2023 18:30:57 +0100 Subject: [PATCH] tweaks `FzfDistance`'s docs --- src/algos/fzf/distance.rs | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/src/algos/fzf/distance.rs b/src/algos/fzf/distance.rs index a8839f7..cf10d8c 100644 --- 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);