diff options
| author | w0rp <devw0rp@gmail.com> | 2018-06-20 23:10:01 +0100 |
|---|---|---|
| committer | w0rp <devw0rp@gmail.com> | 2018-06-20 23:10:01 +0100 |
| commit | 34755eecdd767880af58a91c1b275fdd5ea843a8 (patch) | |
| tree | d1340eea6bcd798e161fbe90730b0ca2aeac0aed | |
| parent | 90dfe8e2a4ba06673cfe83a958ff20a449b8c128 (diff) | |
| download | ale-34755eecdd767880af58a91c1b275fdd5ea843a8.zip | |
#1398 document the detail key
| -rw-r--r-- | doc/ale.txt | 13 |
1 files changed, 10 insertions, 3 deletions
diff --git a/doc/ale.txt b/doc/ale.txt index 415c0cf8..5891debd 100644 --- a/doc/ale.txt +++ b/doc/ale.txt @@ -1970,9 +1970,13 @@ ALEDisableBuffer *ALEDisableBuffer* *:ALEDetail* ALEDetail *ALEDetail* - Show the full linter message for the current line in the preview window. - This will only have an effect on lines that contain a linter message. The - preview window can be easily closed with the `q` key. + Show the full linter message for the problem nearest to the cursor on the + given line in the preview window. The preview window can be easily closed + 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. @@ -2163,6 +2167,9 @@ ale#linter#Define(filetype, linter) *ale#linter#Define()* the following manner: *ale-loclist-format* `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 will be automatically converted to numbers by using `str2nr()`. |