summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorw0rp <devw0rp@gmail.com>2017-02-12 19:26:18 +0000
committerw0rp <devw0rp@gmail.com>2017-02-12 19:26:18 +0000
commita995daa82704740717377e1d9c03785b9b3f2a63 (patch)
treea24c7e8bc5105316dae14dab71ae5af81160dbe3
parent83b46f66f81bb45fa46190b23d980de993769595 (diff)
downloadale-a995daa82704740717377e1d9c03785b9b3f2a63.zip
Fix #325 - document the ALEToggle option
-rw-r--r--doc/ale.txt16
1 files changed, 16 insertions, 0 deletions
diff --git a/doc/ale.txt b/doc/ale.txt
index e3eaacae..110f9075 100644
--- a/doc/ale.txt
+++ b/doc/ale.txt
@@ -175,6 +175,16 @@ g:ale_echo_msg_warning_str *g:ale_echo_msg_warning_str*
Note |`g:ale_echo_msg_format`| should contain the `%severity%` handler
+g:ale_enabled *g:ale_enabled*
+
+ Type: |Number|
+ Default: `1`
+
+ When set to `0`, this option will completely disable ALE, such that no
+ error checking will be performed, etc. ALE can be toggled on and off with
+ the |ALEToggle| command, which changes this option.
+
+
g:ale_keep_list_window_open *g:ale_keep_list_window_open*
Type: |Number|
@@ -1041,6 +1051,12 @@ ALENextWrap *ALENextWrap*
nmap <silent> <C-j> <Plug>(ale_next_wrap)
<
+ALEToggle *ALEToggle*
+
+ Enable or disable ALE, including all of its autocmd events, loclist items,
+ quickfix items, signs, current jobs, etc. Calling this option will change
+ the |g:ale_enabled| variable.
+
===============================================================================
7. API *ale-api*