From 143c3cd09f52996c90b78059275a400d3c2327b0 Mon Sep 17 00:00:00 2001 From: w0rp Date: Tue, 25 Sep 2018 10:17:45 +0100 Subject: [PATCH] #1941 Explain how to alleviate a timeoutlen Vim bug by changing settings --- doc/ale.txt | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/doc/ale.txt b/doc/ale.txt index 46ff08b0..b166d9c5 100644 --- a/doc/ale.txt +++ b/doc/ale.txt @@ -1202,6 +1202,12 @@ g:ale_lint_on_text_changed *g:ale_lint_on_text_changed* ALE will check buffers after a short delay, with a timer which resets on each change. The delay can be configured by adjusting the |g:ale_lint_delay| variable. + *ale-linting-interrupts-mapping* + + Due to a bug in Vim, ALE can interrupt mappings with pending key presses, + per |timeoutlen|. If this happens, follow the advice for enabling + |g:ale_lint_on_insert_leave| below, and set this option to `'normal'`, or + disable it entirely. You should set this setting once before ALE is loaded, and restart Vim if you want to change your preferences. See |ale-lint-settings-on-startup|. @@ -1217,7 +1223,7 @@ g:ale_lint_on_insert_leave *g:ale_lint_on_insert_leave* ALE will not lint files when you escape insert mode with |CTRL-C| by default. You can make ALE lint files with this option when you use |CTRL-C| - with the following keybind. > + with the following mapping. > " Make using Ctrl+C do the same as Escape, to trigger autocmd commands inoremap