hasufell/ale
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Clean up grammar for hover documentation a little

Browse Source
This commit is contained in:
w0rp 2018-05-30 19:44:01 +01:00
parent 106d439f56
commit f95bc00bd6
No known key found for this signature in database
GPG Key ID: 0FC1ECAA8C81CD83
1 changed files with 15 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
doc/ale.txt
View File

@ -668,14 +668,11 @@ at the cursor taken from LSP linters. The following commands are supported:
|ALEHover| - Print information about the symbol at the cursor. |ALEHover| - Print information about the symbol at the cursor.
If |b:ale_set_balloons| is set and you are are using vim with the If |b:ale_set_balloons| is set to `1` and your version of Vim supports the
|balloon_show()| feature (tested with vim 8 patch 1318), then "hover" |balloon_show()| function, then "hover" information also show up when you move
information also show up when you put the mouse on a symbol in a buffer the mouse over a symbol in a buffer. Diagnostic information will take priority
("mouseover"). over hover information for balloons. If a line contains a problem, that
Diagnostics information have priority over hover information for the balloon problem will be displayed in a balloon instead of hover information.
space : if there is a diagnostics message (warning or error) on the line the
mouse points to, then the mouseover will print this information instead of
hover information.
=============================================================================== ===============================================================================
@ -1349,20 +1346,23 @@ g:ale_set_balloons *g:ale_set_balloons*
*b:ale_set_balloons* *b:ale_set_balloons*
Type: |Number| Type: |Number|
Default: `has('balloon_eval') && has('gui_running') ||` Default: `(has('balloon_eval') && has('gui_running'))`
`has('balloon_eval_term') && !has('gui_running')` `|| (has('balloon_eval_term') && !has('gui_running'))`
When this option is set to `1`, balloon messages will be displayed for When this option is set to `1`, balloon messages will be displayed for
problems or hover information if relevant. Problems nearest to the cursor on problems or hover information if available.
the line the cursor is over will be displayed. If there are no problem, and
one of the linters support |ale-hover|, then brief information about the Problems nearest to the line the mouse cursor is over will be displayed. If
symbol under the cursor will be shown. Balloons will not be shown when there are no problems to show, and one of the linters is an LSP linter
either |g:ale_enabled| is `0` or |b:ale_enabled| is `0`. supporting "Hover" information, per |ale-hover|, then brief information
about the symbol under the cursor will be displayed in a balloon.
`b:ale_set_balloons` can be set to `0` to disable balloons for a buffer. `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 Balloons cannot be enabled for a specific buffer when not initially enabled
globally. globally.
Balloons will not be shown when |g:ale_enabled| or |b:ale_enabled| is `0`.
g:ale_set_balloons_legacy_echo *g:ale_set_balloons_legacy_echo* g:ale_set_balloons_legacy_echo *g:ale_set_balloons_legacy_echo*
*b:ale_set_balloons_legacy_echo* *b:ale_set_balloons_legacy_echo*