docs: add warning on prefetch_on_insert

Saghen · Dec 13, 2024 · ec9b71c · ec9b71c
1 parent 54d1a98
commit ec9b71c
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -282,6 +282,7 @@ MiniDeps.add({
 
     trigger = {
       -- When true, will prefetch the completion items when entering insert mode
+      -- WARN: buggy, not recommended unless you'd like to help develop prefetching
       prefetch_on_insert = false,
       -- When false, will not show the completion window automatically when in a snippet
       show_in_snippet = true,

diff --git a/lua/blink/cmp/config/completion/trigger.lua b/lua/blink/cmp/config/completion/trigger.lua
@@ -1,5 +1,5 @@
 --- @class (exact) blink.cmp.CompletionTriggerConfig
---- @field prefetch_on_insert boolean When true, will prefetch the completion items when entering insert mode
+--- @field prefetch_on_insert boolean When true, will prefetch the completion items when entering insert mode. WARN: buggy, not recommended unless you'd like to help develop prefetching
 --- @field show_in_snippet boolean When false, will not show the completion window when in a snippet
 --- @field show_on_keyword boolean When true, will show the completion window after typing a character that matches the `keyword.regex`
 --- @field show_on_trigger_character boolean When true, will show the completion window after typing a trigger character