Tell people to turn the completion option on before loading ALE

This commit is contained in:
w0rp 2018-10-18 09:10:59 +01:00
parent be21aa5cda
commit 3b38a83ae9
No known key found for this signature in database
GPG Key ID: 0FC1ECAA8C81CD83
2 changed files with 10 additions and 5 deletions

View File

@ -26,7 +26,7 @@ features, including:
* Diagnostics (via Language Server Protocol linters) * Diagnostics (via Language Server Protocol linters)
* Go To Definition (`:ALEGoToDefinition`) * 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`) * Finding references (`:ALEFindReferences`)
* Hover information (`:ALEHover`) * Hover information (`:ALEHover`)
@ -277,6 +277,7 @@ Protocol linters, or from `tsserver` for TypeScript.
```vim ```vim
" Enable completion where available. " Enable completion where available.
" This setting must be set before ALE is loaded.
let g:ale_completion_enabled = 1 let g:ale_completion_enabled = 1
``` ```

View File

@ -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. will only suggest symbols provided by the LSP servers.
Suggestions will be made while you type after completion is enabled. Suggestions will be made while you type after completion is enabled.
Completion can be enabled by setting |g:ale_completion_enabled| to `1`. The Completion can be enabled by setting |g:ale_completion_enabled| to `1`. This
delay for completion can be configured with |g:ale_completion_delay|. ALE will setting must be set to `1` before ALE is loaded. The delay for completion can
only suggest so many possible matches for completion. The maximum number of be configured with |g:ale_completion_delay|. ALE will only suggest so many
items can be controlled with |g:ale_completion_max_suggestions|. 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 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|. 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. 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| See |ale-completion|