document that CwdAwareHinter is only compatible with sqlite history

nushell · Oct 19, 2023 · 00c59e4 · 00c59e4
1 parent 51f05e6
commit 00c59e4
Showing 1 changed file with 1 addition and 1 deletion.
diff --git a/src/hinter/cwd_aware.rs b/src/hinter/cwd_aware.rs
@@ -4,7 +4,7 @@ use crate::{history::SearchQuery, Hinter, History};
 use nu_ansi_term::{Color, Style};
 
 /// A hinter that uses the completions or the history to show a hint to the user
-///
+/// NOTE: Only use this with `SqliteBackedHistory`!
 /// Similar to `fish` autosuggestins
 #[cfg(any(feature = "sqlite", feature = "sqlite-dynlib"))]
 pub struct CwdAwareHinter {