summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorw0rp <devw0rp@gmail.com>2017-05-27 21:27:42 +0100
committerw0rp <devw0rp@gmail.com>2017-05-27 21:27:42 +0100
commitaca5a00fb7b00655685a4306f1517d4e0f9126ee (patch)
treef41fac4c2166abaabeadb188c00c0de813f0e484 /doc
parent8e997ac2319efac06f7ca6b0912ca00a47ba26d1 (diff)
downloadale-aca5a00fb7b00655685a4306f1517d4e0f9126ee.zip
Fix #500 - Support defining aliases for linter names
Diffstat (limited to 'doc')
-rw-r--r--doc/ale.txt7
1 files changed, 7 insertions, 0 deletions
diff --git a/doc/ale.txt b/doc/ale.txt
index 514ba730..8fb048e6 100644
--- a/doc/ale.txt
+++ b/doc/ale.txt
@@ -1078,6 +1078,13 @@ ale#linter#Define(filetype, linter) *ale#linter#Define()*
be set automatically to `0`. The two options cannot
be used together.
+ `aliases` A |List| of aliases for the linter name.
+
+ This option can be set with alternative names for
+ for selecting the linter with |g:ale_linters|. This
+ setting can make it easier to guess the linter name
+ by offering a few alternatives.
+
Only one of `command`, `command_callback`, or `command_chain` should be
specified. `command_callback` is generally recommended when a command string
needs to be generated dynamically, or any global options are used.