branch: externals/corfu
commit 2c3947d415cee368a44b2e4310be48d722e9c29c
Author: Daniel Mendler <m...@daniel-mendler.de>
Commit: Daniel Mendler <m...@daniel-mendler.de>
Expand docstrings
---
corfu.el | 9 +++++++--
1 file changed, 7 insertions(+), 2 deletions(-)
diff --git a/corfu.el b/corfu.el
index 7d9c247a64..2e1d3ed382 100644
--- a/corfu.el
+++ b/corfu.el
@@ -159,11 +159,16 @@ return a string, possibly an icon."
(defcustom corfu-auto-prefix 3
"Minimum length of prefix for auto completion.
The completion backend can override this with
-:company-prefix-length."
+:company-prefix-length. It is *not recommended* to use a small
+value here (below 2), since this will create high load for
+Emacs. See also `corfu-auto-delay'."
:type 'natnum)
(defcustom corfu-auto-delay 0.2
- "Delay for auto completion."
+ "Delay for auto completion.
+It is *not recommended* to use a very small value or even 0,
+since this will create high load for Emacs in particular if the
+completion backend in use is expensive."
:type 'float)
(defcustom corfu-auto-commands
