From 8036b61ad18c3fcd4db1a865254924ca6729c73c Mon Sep 17 00:00:00 2001 From: Henry Bley-Vroman Date: Mon, 19 Dec 2022 11:53:31 -1000 Subject: [PATCH] docs: widgets calling autosuggestion widgets must be ignored (#716) --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 3cfd2e8..e35f8ef 100644 --- a/README.md +++ b/README.md @@ -73,6 +73,7 @@ Widgets that modify the buffer and are not found in any of these arrays will fet **Note:** A widget shouldn't belong to more than one of the above arrays. +**Note:** Any widget which calls one of the [autosuggestion widgets](#autosuggestion-widgets) must be added to `ZSH_AUTOSUGGEST_IGNORE_WIDGETS` before creating the new widget's keymap. ### Disabling suggestion for large buffers @@ -102,7 +103,7 @@ Set `ZSH_AUTOSUGGEST_COMPLETION_IGNORE` to a [glob pattern](http://zsh.sourcefor **Note:** This only affects the `completion` suggestion strategy. -### Key Bindings +### Autosuggestion widgets This plugin provides a few widgets that you can use with `bindkey`: