marc/ale
Archived
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Make it less likely people will do the wrong thing

Browse source 
Make it very clear in every single place that the setting for ALE's own
completion implementation is mentioned that you should not enable it if
you want to use ALE as a completion source for other plugins like
Deoplete.
This commit is contained in:
w0rp 2019-05-11 17:06:32 +01:00
parent f0152bca98
commit edd3114394
No known key found for this signature in database
GPG key ID: 0FC1ECAA8C81CD83
2 changed files with 11 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
README.md
View file

@ -174,6 +174,9 @@ other plugins, and can be enabled by changing a setting before ALE is loaded.
```vim ```vim
" Enable completion where available. " Enable completion where available.
" This setting must be set before ALE is loaded. " This setting must be set before ALE is loaded.
"
" You should not turn this setting on if you wish to use ALE as a completion
" source for other completion plugins, like Deoplete.
let g:ale_completion_enabled = 1 let g:ale_completion_enabled = 1
``` ```

11
doc/ale.txt
View file

@ -343,9 +343,11 @@ integration should not be combined with ALE's own implementation.
ALE also offers its own completion implementation, which does not require any ALE also offers its own completion implementation, which does not require any
other plugins. Suggestions will be made while you type after completion is other plugins. Suggestions will be made while you type after completion is
enabled. Completion can be enabled by setting |g:ale_completion_enabled| to enabled. ALE's own completion implementation can be enabled by setting
`1`. This setting must be set to `1` before ALE is loaded. The delay for |g:ale_completion_enabled| to `1`. This setting must be set to `1` before ALE
completion can be configured with |g:ale_completion_delay|. is loaded. The delay for completion can be configured with
|g:ale_completion_delay|. This setting should not be enabled if you wish to
use ALE as a completion source for other plugins.
ALE will only suggest so many possible matches for completion. The maximum ALE will only suggest so many possible matches for completion. The maximum
number of items can be controlled with |g:ale_completion_max_suggestions|. number of items can be controlled with |g:ale_completion_max_suggestions|.
@ -567,6 +569,9 @@ g:ale_completion_enabled *g:ale_completion_enabled*
This setting must be set to `1` before ALE is loaded for this behavior This setting must be set to `1` before ALE is loaded for this behavior
to be enabled. to be enabled.
This setting should not be enabled if you wish to use ALE as a completion
source for other completion plugins.
See |ale-completion| See |ale-completion|