diff options
| author | Fred Emmott <fe@fb.com> | 2018-08-02 09:18:43 -0700 |
|---|---|---|
| committer | Fred Emmott <fe@fb.com> | 2018-08-02 09:24:45 -0700 |
| commit | e722841fa38cf5adefa9bc5fbdeb8f0f9a0e637d (patch) | |
| tree | eb441568c9890300503ac05e8335fccb8c3f3c00 /doc | |
| parent | 2768bf15ba5ca95f126405459c4a8180e814af18 (diff) | |
| download | ale-e722841fa38cf5adefa9bc5fbdeb8f0f9a0e637d.zip | |
Improved documentation for `code` loclist item field
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/ale.txt | 7 |
1 files changed, 4 insertions, 3 deletions
diff --git a/doc/ale.txt b/doc/ale.txt index e68ba9df..d6a80acc 100644 --- a/doc/ale.txt +++ b/doc/ale.txt @@ -2318,11 +2318,12 @@ ale#linter#Define(filetype, linter) *ale#linter#Define()* `type` - Defaults to `'E'`. `nr` - Defaults to `-1`. - Numeric error code. If `nr` is not `-1`, `code` should have + Numeric error code. If `nr` is not `-1`, `code` + likely should contain the string representation of the same value. - `code` - No default. + `code` - No default; may be unset. - String error code. + Human-readable |String| error code. `executable` A |String| naming the executable itself which will be run. This value will be used to check if the |