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

#1398 document the detail key

Browse Source
This commit is contained in:
w0rp 2018-06-20 23:10:01 +01:00
parent 90dfe8e2a4
commit 34755eecdd
No known key found for this signature in database
GPG Key ID: 0FC1ECAA8C81CD83
1 changed files with 10 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
doc/ale.txt
View File

@ -1970,9 +1970,13 @@ ALEDisableBuffer *ALEDisableBuffer*
*:ALEDetail* *:ALEDetail*
ALEDetail *ALEDetail* ALEDetail *ALEDetail*
Show the full linter message for the current line in the preview window. Show the full linter message for the problem nearest to the cursor on the
This will only have an effect on lines that contain a linter message. The given line in the preview window. The preview window can be easily closed
preview window can be easily closed with the `q` key. with the `q` key. If there is no message to show, the window will not be
opened.
If a loclist item has a `detail` key set, the message for that key will be
preferred over `text`. See |ale-loclist-format|.
A plug mapping `<Plug>(ale_detail)` is defined for this command. A plug mapping `<Plug>(ale_detail)` is defined for this command.
@ -2163,6 +2167,9 @@ ale#linter#Define(filetype, linter) *ale#linter#Define()*
the following manner: the following manner:
*ale-loclist-format* *ale-loclist-format*
`text` - This error message is required. `text` - This error message is required.
`detail` - An optional, more descriptive message.
This message can be displayed with the |ALEDetail|
command instead of the message for `text`, if set.
`lnum` - The line number is required. Any strings `lnum` - The line number is required. Any strings
will be automatically converted to numbers by will be automatically converted to numbers by
using `str2nr()`. using `str2nr()`.