summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorw0rp <devw0rp@gmail.com>2018-10-18 09:10:59 +0100
committerw0rp <devw0rp@gmail.com>2018-10-18 09:11:06 +0100
commit3b38a83ae9c221e0f4589f087bfb6b43056e3943 (patch)
tree9f4597db8e3cf16c8b0c02cf78f4d6618707ac81
parentbe21aa5cda39850d9f0261e3b6cac9d48a170756 (diff)
downloadale-3b38a83ae9c221e0f4589f087bfb6b43056e3943.zip
Tell people to turn the completion option on before loading ALE
-rw-r--r--README.md3
-rw-r--r--doc/ale.txt12
2 files changed, 10 insertions, 5 deletions
diff --git a/README.md b/README.md
index a99b500f..75f5346a 100644
--- a/README.md
+++ b/README.md
@@ -26,7 +26,7 @@ features, including:
* Diagnostics (via Language Server Protocol linters)
* Go To Definition (`:ALEGoToDefinition`)
-* Completion (`let g:ale_completion_enabled = 1`)
+* Completion (`let g:ale_completion_enabled = 1` before ALE is loaded)
* Finding references (`:ALEFindReferences`)
* Hover information (`:ALEHover`)
@@ -277,6 +277,7 @@ Protocol linters, or from `tsserver` for TypeScript.
```vim
" Enable completion where available.
+" This setting must be set before ALE is loaded.
let g:ale_completion_enabled = 1
```
diff --git a/doc/ale.txt b/doc/ale.txt
index e9dd3a8e..ffaffbbf 100644
--- a/doc/ale.txt
+++ b/doc/ale.txt
@@ -711,10 +711,11 @@ Completion is only supported while at least one LSP linter is enabled. ALE
will only suggest symbols provided by the LSP servers.
Suggestions will be made while you type after completion is enabled.
-Completion can be enabled by setting |g:ale_completion_enabled| to `1`. The
-delay for completion can be configured with |g:ale_completion_delay|. ALE will
-only suggest so many possible matches for completion. The maximum number of
-items can be controlled with |g:ale_completion_max_suggestions|.
+Completion can be enabled by setting |g:ale_completion_enabled| to `1`. This
+setting must be set to `1` before ALE is loaded. The delay for completion can
+be configured with |g:ale_completion_delay|. ALE will only suggest so many
+possible matches for completion. The maximum number of items can be controlled
+with |g:ale_completion_max_suggestions|.
If you don't like some of the suggestions you see, you can filter them out
with |g:ale_completion_excluded_words| or |b:ale_completion_excluded_words|.
@@ -891,6 +892,9 @@ g:ale_completion_enabled *g:ale_completion_enabled*
When this option is set to `1`, completion support will be enabled.
+ This setting must be set to `1` before ALE is loaded for this behavior
+ to be enabled.
+
See |ale-completion|