From 3b38a83ae9c221e0f4589f087bfb6b43056e3943 Mon Sep 17 00:00:00 2001 From: w0rp Date: Thu, 18 Oct 2018 09:10:59 +0100 Subject: [PATCH] Tell people to turn the completion option on before loading ALE --- README.md | 3 ++- doc/ale.txt | 12 ++++++++---- 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|