summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorw0rp <devw0rp@gmail.com>2018-07-20 16:10:25 +0100
committerw0rp <devw0rp@gmail.com>2018-07-20 16:10:25 +0100
commit0d37aaac7a6f2a6291d7db1032fe08196164fc73 (patch)
tree5ee368213dfa866d43a28adc3d2e93f14b7ae15f /doc
parent61a5880747128dbf988a076e190ccb346500b5ff (diff)
downloadale-0d37aaac7a6f2a6291d7db1032fe08196164fc73.zip
Fix #1631 - Disable balloon support for terminals by default
Diffstat (limited to 'doc')
-rw-r--r--doc/ale.txt9
1 files changed, 7 insertions, 2 deletions
diff --git a/doc/ale.txt b/doc/ale.txt
index 2b25091e..96bbc89b 100644
--- a/doc/ale.txt
+++ b/doc/ale.txt
@@ -1413,8 +1413,7 @@ g:ale_set_balloons *g:ale_set_balloons*
*b:ale_set_balloons*
Type: |Number|
- Default: `(has('balloon_eval') && has('gui_running'))`
- `|| (has('balloon_eval_term') && !has('gui_running'))`
+ Default: `has('balloon_eval') && has('gui_running')`
When this option is set to `1`, balloon messages will be displayed for
problems or hover information if available.
@@ -1424,6 +1423,12 @@ g:ale_set_balloons *g:ale_set_balloons*
supporting "Hover" information, per |ale-hover|, then brief information
about the symbol under the cursor will be displayed in a balloon.
+ Balloons can be enabled for terminal versions of Vim that support balloons,
+ but some versions of Vim will produce strange mouse behavior when balloons
+ are enabled. To configure balloons for your terminal, you should first
+ configure your |ttymouse| setting, and then consider setting
+ `g:ale_set_balloons` to `1` before ALE is loaded.
+
`b:ale_set_balloons` can be set to `0` to disable balloons for a buffer.
Balloons cannot be enabled for a specific buffer when not initially enabled
globally.