summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorw0rp <devw0rp@gmail.com>2017-07-16 00:40:20 +0100
committerw0rp <devw0rp@gmail.com>2017-07-16 00:40:20 +0100
commit15c48650e7593e189887bd2d342f1736fbf52919 (patch)
tree8cfe70fe8adef03efbb339f213202b1cc072b877 /doc
parentcad9fc19c65ddd0e20456ce345de81e6b03f331e (diff)
downloadale-15c48650e7593e189887bd2d342f1736fbf52919.zip
#739 - Document the end_col and end_lnum keys for the loclist format
Diffstat (limited to 'doc')
-rw-r--r--doc/ale.txt8
1 files changed, 7 insertions, 1 deletions
diff --git a/doc/ale.txt b/doc/ale.txt
index ab5714c2..642d3883 100644
--- a/doc/ale.txt
+++ b/doc/ale.txt
@@ -1257,7 +1257,7 @@ ale#linter#Define(filetype, linter) *ale#linter#Define()*
The keys for each item in the List will be handled in
the following manner:
-
+ *ale-loclist-format*
`text` - This error message is required.
`lnum` - The line number is required. Any strings
will be automatically converted to numbers by
@@ -1268,6 +1268,12 @@ ale#linter#Define(filetype, linter) *ale#linter#Define()*
`col` - The column number is optional and will
default to `0`. Any strings will be automatically
coverted to number using `str2nr()`.
+ `end_col` - An optional end column number.
+ This key can be set to specify the column problems
+ end on, for improved highlighting.
+ `end_lnum` - An optional end line number.
+ This key can set along with `end_col` for
+ highlighting multi-line problems.
`bufnr` - The buffer number should match the buffer
being checked, and this value will default to
the buffer being checked.