branch: externals/minuet
commit 3d706144ddc6a7701c57b25f328ac94223994513
Author: Milan Glacier <[email protected]>
Commit: Milan Glacier <[email protected]>
doc: update README.
---
README.md | 19 +++++++++++++------
1 file changed, 13 insertions(+), 6 deletions(-)
diff --git a/README.md b/README.md
index e7e658d345..f00a13c3d7 100644
--- a/README.md
+++ b/README.md
@@ -18,6 +18,7 @@
-
[minuet-show-error-message-on-minibuffer](#minuet-show-error-message-on-minibuffer)
- [minuet-add-single-line-entry](#minuet-add-single-line-entry)
- [minuet-n-completions](#minuet-n-completions)
+ -
[minuet-auto-suggestion-block-predicates](#minuet-auto-suggestion-block-predicates)
-
[minuet-auto-suggestion-debounce-delay](#minuet-auto-suggestion-debounce-delay)
-
[minuet-auto-suggestion-throttle-delay](#minuet-auto-suggestion-throttle-delay)
- [Provider Options](#provider-options)
@@ -277,12 +278,12 @@ completion request.
# Selecting a Provider or Model
-The `gemini-flash` and `codestral` models offer high-quality output with free
-and fast processing. For optimal quality (albeit slower generation speed),
-consider using the `deepseek-chat` model, which is compatible with both
-`openai-fim-compatible` and `openai-compatible` providers. For local LLM
-inference, you can deploy either `qwen-2.5-coder` or `deepseek-coder-v2`
through
-Ollama using the `openai-fim-compatible` provider.
+The `gemini-2.0-flash` and `codestral` models offer high-quality output with
+free and fast processing. For optimal quality, though with significantly slower
+generation speed, consider using the `deepseek-chat` model, which is compatible
+with both `openai-fim-compatible` and `openai-compatible` providers. For local
+LLM inference, you can deploy either `qwen-2.5-coder` or `deepseek-coder-v2`
+through Ollama using the `openai-fim-compatible` provider.
Note: as of January 27, 2025, the high server demand from deepseek may
significantly slow down the default provider used by Minuet
@@ -393,6 +394,12 @@ The default is `3`.
If resource efficiency is imporant, it is recommended to set this value to `1`.
+## minuet-auto-suggestion-block-predicates
+
+List of predicate functions that decide whether auto-suggestions should be
+suppressed. Each function is called before requesting a suggestion; if any
+returns non-nil no suggestion is requested for that moment.
+
## minuet-auto-suggestion-debounce-delay
The delay in seconds before sending a completion request after typing stops.
The
