summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorw0rp <devw0rp@gmail.com>2019-05-11 17:06:32 +0100
committerw0rp <devw0rp@gmail.com>2019-05-11 17:06:32 +0100
commitedd31143946aa396a0021174b0dfb6927b630856 (patch)
tree2dd1057724ade87db795bbc12eb63a61fbfa4f03
parentf0152bca987272e257e5dbe39d835c7d8e85b367 (diff)
downloadale-edd31143946aa396a0021174b0dfb6927b630856.zip
Make it less likely people will do the wrong thing
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.
-rw-r--r--README.md3
-rw-r--r--doc/ale.txt11
2 files changed, 11 insertions, 3 deletions
diff --git a/README.md b/README.md
index a35a62ab..1de2b412 100644
--- a/README.md
+++ b/README.md
@@ -174,6 +174,9 @@ other plugins, and can be enabled by changing a setting before ALE is loaded.
```vim
" Enable completion where available.
" 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
```
diff --git a/doc/ale.txt b/doc/ale.txt
index 5b290b06..2c18d6a1 100644
--- a/doc/ale.txt
+++ b/doc/ale.txt
@@ -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
other plugins. Suggestions will be made while you type after completion is
-enabled. 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|.
+enabled. ALE's own completion implementation 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|. 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
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
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|