add docs to FzfQuery

nomad · Nov 19, 2023 · f7d7951 · f7d7951
1 parent 11a64ed
commit f7d7951
Showing 1 changed file with 4 additions and 1 deletion.
diff --git a/src/algos/fzf/query.rs b/src/algos/fzf/query.rs
@@ -15,7 +15,10 @@ type FuzzyAlgo<T> = fn(
     &mut MatchedRanges,
 ) -> Option<Score>;
 
-/// TODO: docs.
+/// A parsed fzf query.
+///
+/// This struct is created by the [`parse`](FzfParser::parse) method on
+/// [`FzfParser`]. See its documentation for more.
 #[derive(Clone, Copy)]
 pub struct FzfQuery<'a> {
     pub(super) search_mode: SearchMode<'a>,