diff options
| author | w0rp <devw0rp@gmail.com> | 2022-12-25 19:29:16 +0000 |
|---|---|---|
| committer | w0rp <devw0rp@gmail.com> | 2022-12-25 19:29:16 +0000 |
| commit | 300ea232de003f5ce45549be85d5da7f84fe23b0 (patch) | |
| tree | 8d0e22ab281b791d72b8942128e0fca07bf2c106 /doc | |
| parent | 522b5d0433ba8c29f2f154f62184e34c2e5f301f (diff) | |
| download | ale-300ea232de003f5ce45549be85d5da7f84fe23b0.zip | |
Close #4397 - Add human-readable values for g:ale_virtualtext_cursor
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/ale.txt | 16 |
1 files changed, 7 insertions, 9 deletions
diff --git a/doc/ale.txt b/doc/ale.txt index 01474860..eca8d2de 100644 --- a/doc/ale.txt +++ b/doc/ale.txt @@ -2290,16 +2290,14 @@ g:ale_use_global_executables *g:ale_use_global_executables* g:ale_virtualtext_cursor *g:ale_virtualtext_cursor* Type: |Number| - Default: `0` + Default: `'disabled'` + + This option controls how ALE will display problems using |virtual-text|. + The following values can be used. - When this option is set to `1`, a message will be shown when a cursor is - near a warning or error. ALE will attempt to find the warning or error at a - column nearest to the cursor when the cursor is resting on a line which - contains a warning or error. This option can be set to `0` to disable this - behavior. - When this option is set to `2`, then all warnings will be shown for the - whole buffer, regardless of if the cursor is currently positioned in that - line. + `'all'`, `'2'`, or `2` - Show problems for all lines. + `'current'`, `'1'`, or `1` - Show problems for the current line. + `'disabled'`, `'0'`, or `0` - Do not show problems with virtual-text. Messages are only displayed after a short delay. See |g:ale_virtualtext_delay|. |