Make help text clearer for line number highlights
This commit is contained in:
parent
9f814a8ce9
commit
6e18c03d80
1 changed files with 8 additions and 5 deletions
13
doc/ale.txt
13
doc/ale.txt
|
@ -1437,9 +1437,8 @@ g:ale_set_signs *g:ale_set_signs*
|
||||||
|ALEWarningLine| - All items with `'type': 'W'`
|
|ALEWarningLine| - All items with `'type': 'W'`
|
||||||
|ALEInfoLine| - All items with `'type': 'I'`
|
|ALEInfoLine| - All items with `'type': 'I'`
|
||||||
|
|
||||||
With Neovim 0.3.2 or higher, ALE can use `numhl` option to highlight 'number'
|
With Neovim 0.3.2 or higher, ALE can use the `numhl` option to highlight the
|
||||||
column. It uses the following highlight groups. To enable this feature,
|
'number' column. It uses the following highlight groups.
|
||||||
see |g:ale_sign_highlight_linenrs|.
|
|
||||||
|
|
||||||
|ALEErrorSignLineNr| - Items with `'type': 'E'`
|
|ALEErrorSignLineNr| - Items with `'type': 'E'`
|
||||||
|ALEWarningSignLineNr| - Items with `'type': 'W'`
|
|ALEWarningSignLineNr| - Items with `'type': 'W'`
|
||||||
|
@ -1447,6 +1446,9 @@ g:ale_set_signs *g:ale_set_signs*
|
||||||
|ALEStyleErrorSignLineNr| - Items with `'type': 'E'` and `'sub_type': 'style'`
|
|ALEStyleErrorSignLineNr| - Items with `'type': 'E'` and `'sub_type': 'style'`
|
||||||
|ALEStyleWarningSignLineNr| - Items with `'type': 'W'` and `'sub_type': 'style'`
|
|ALEStyleWarningSignLineNr| - Items with `'type': 'W'` and `'sub_type': 'style'`
|
||||||
|
|
||||||
|
To enable line number highlighting |g:ale_sign_highlight_linenrs| must be
|
||||||
|
set to `1` before ALE is loaded.
|
||||||
|
|
||||||
The markers for the highlights can be customized with the following options:
|
The markers for the highlights can be customized with the following options:
|
||||||
|
|
||||||
|g:ale_sign_error|
|
|g:ale_sign_error|
|
||||||
|
@ -1558,8 +1560,9 @@ g:ale_sign_highlight_linenrs *g:ale_sign_highlight_linenrs
|
||||||
Type: |Number|
|
Type: |Number|
|
||||||
Default: `0`
|
Default: `0`
|
||||||
|
|
||||||
This option controls whether ALE should use `numhl` option to highlight 'number'
|
When set to `1`, this option enables highlighting problems on the 'number'
|
||||||
column in supported vim version.
|
column in Vim versions that support `numhl` highlights. This option must be
|
||||||
|
configured before ALE is loaded.
|
||||||
|
|
||||||
|
|
||||||
g:ale_update_tagstack *g:ale_update_tagstack*
|
g:ale_update_tagstack *g:ale_update_tagstack*
|
||||||
|
|
Reference in a new issue