diff options
| author | w0rp <devw0rp@gmail.com> | 2017-08-20 00:16:28 +0100 |
|---|---|---|
| committer | w0rp <devw0rp@gmail.com> | 2017-08-20 00:16:28 +0100 |
| commit | e5d0a17694897dc8e234f534cfa33fc3483d8e12 (patch) | |
| tree | 4ea0e00b5b6d3fc29d5f6a7292ed6438b1c50243 /doc | |
| parent | 7112776d1b04d2cb01a1b01c0edfa5b86ed88e99 (diff) | |
| download | ale-e5d0a17694897dc8e234f534cfa33fc3483d8e12.zip | |
#653 - Explain the new `filename` key support in the documentation
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/ale.txt | 24 |
1 files changed, 21 insertions, 3 deletions
diff --git a/doc/ale.txt b/doc/ale.txt index 6a067dbe..12d9d2e5 100644 --- a/doc/ale.txt +++ b/doc/ale.txt @@ -1365,9 +1365,27 @@ ale#linter#Define(filetype, linter) *ale#linter#Define()* `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. + `bufnr` - This key represents the buffer number the + problems are for. This value will default to + the buffer number being checked. + + The `filename` key can be set instead of this key, + and then the eventual `bufnr` value in the final + list will either represent the number for an open + buffer or `-1` for a file not open in any buffer. + `filename` - An optional filename for the file the + problems are for. This should be an absolute path to + a file. + + Problems for files which have not yet been opened + will be set in those files after they are opened + and have been checked at least once. + + Temporary files in directories used for Vim + temporary files with `tempname()` will be asssumed + to be the buffer being checked, unless the `bufnr` + key is also set with a valid number for some other + buffer. `vcol` - Defaults to `0`. `type` - Defaults to `'E'`. `nr` - Defaults to `-1`. |