summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorw0rp <devw0rp@gmail.com>2019-06-10 20:54:38 +0100
committerw0rp <devw0rp@gmail.com>2019-06-10 20:54:38 +0100
commit168768b32667b244e0afdc8da851d91ab95d6e2f (patch)
tree61c022da7b2584ac9b4a405ba201ed01200dd99d /doc
parent8b46fa3ee716485b4dd7c3f86c9302a140be6bfa (diff)
downloadale-168768b32667b244e0afdc8da851d91ab95d6e2f.zip
Lint on InsertLeave, not in insert mode by default
b:ale_lint_on_insert_leave is now supported as tests need it. These defaults are saner and cause fewer issues for users by default.
Diffstat (limited to 'doc')
-rw-r--r--doc/ale.txt9
1 files changed, 7 insertions, 2 deletions
diff --git a/doc/ale.txt b/doc/ale.txt
index 736d8e05..6aa03a12 100644
--- a/doc/ale.txt
+++ b/doc/ale.txt
@@ -84,7 +84,7 @@ have even saved your changes. ALE will check your code in the following
circumstances, which can be configured with the associated options.
* When you modify a buffer. - |g:ale_lint_on_text_changed|
-* On leaving insert mode. (off by default) - |g:ale_lint_on_insert_leave|
+* On leaving insert mode. - |g:ale_lint_on_insert_leave|
* When you open a new or modified buffer. - |g:ale_lint_on_enter|
* When you save a buffer. - |g:ale_lint_on_save|
* When the filetype changes for a buffer. - |g:ale_lint_on_filetype_changed|
@@ -953,7 +953,7 @@ g:ale_lint_on_save *g:ale_lint_on_save*
g:ale_lint_on_text_changed *g:ale_lint_on_text_changed*
Type: |String|
- Default: `'always'`
+ Default: `'normal'`
This option controls how ALE will check your files as you make changes.
The following values can be used.
@@ -978,6 +978,7 @@ g:ale_lint_on_text_changed *g:ale_lint_on_text_changed*
g:ale_lint_on_insert_leave *g:ale_lint_on_insert_leave*
+ *b:ale_lint_on_insert_leave*
Type: |Number|
Default: `0`
@@ -992,6 +993,10 @@ g:ale_lint_on_insert_leave *g:ale_lint_on_insert_leave*
" Make using Ctrl+C do the same as Escape, to trigger autocmd commands
inoremap <C-c> <Esc>
<
+ A buffer-local version of this setting `b:ale_lint_on_insert_leave` can be
+ set to `0` to disable linting when leaving insert mode. The setting must
+ be enabled globally to be enabled locally.
+
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|.