From 81779e60bb756454b90c3fa901186290ec74ef91 Mon Sep 17 00:00:00 2001 From: w0rp Date: Fri, 10 Feb 2017 23:11:26 +0000 Subject: [PATCH] Document the command empty string behaviour --- doc/ale.txt | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/doc/ale.txt b/doc/ale.txt index 4a8f0ec..d0f2487 100644 --- a/doc/ale.txt +++ b/doc/ale.txt @@ -1075,6 +1075,11 @@ ale#linter#Define(filetype, linter) *ale#linter#Define()* place of `command` when more complicated processing is needed. + If an empty string is returned from the callback, + no jobs for linting will be run for that linter. + This can be used for skipping a linter call, + say if no configuration file was found. + `command_chain` A |List| of |Dictionary| items defining a series of commands to be run. At least one |Dictionary| should be provided. Each Dictionary must contain the @@ -1091,6 +1096,13 @@ ale#linter#Define(filetype, linter) *ale#linter#Define()* a `(buffer)` argument, as there are no previous commands to run which return `output`. + If an empty string is returned for a command in a + chain, that command in the chain will be skipped, + and the next function in the chain will be called + immediately instead. If the last command in a chain + returns an empty string, then no linting will be + performed. + Commands in the chain will all use the `output_stream` value provided in the root |Dictionary|. Each command in the chain can also