summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorw0rp <devw0rp@gmail.com>2017-04-23 18:06:26 +0100
committerw0rp <devw0rp@gmail.com>2017-04-23 18:06:26 +0100
commit9238976522df5cd010395c47f9d2f75242e665ea (patch)
tree20b2d74d923e296bac1030d61823f23c99ecc222
parentc1a2d267117ee7cde612e3d66bf039458fc41ce4 (diff)
downloadale-9238976522df5cd010395c47f9d2f75242e665ea.zip
Add some more tags to the documentation, for easy references
-rw-r--r--doc/ale.txt4
1 files changed, 4 insertions, 0 deletions
diff --git a/doc/ale.txt b/doc/ale.txt
index 8011a215..2c3bde73 100644
--- a/doc/ale.txt
+++ b/doc/ale.txt
@@ -794,6 +794,7 @@ ale#linter#Define(filetype, linter) *ale#linter#Define()*
This can be used for skipping a linter call,
say if no configuration file was found.
+ *ale-command-chain*
`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
@@ -848,6 +849,7 @@ ale#linter#Define(filetype, linter) *ale#linter#Define()*
if a command manually reads from a temporary file
instead, etc.
+ *ale-lint-file*
`lint_file` A |Number| (`0` or `1`) indicating whether a command
should read the file instead of the Vim buffer. This
option can be used for linters which must check the
@@ -878,6 +880,8 @@ ale#linter#Define(filetype, linter) *ale#linter#Define()*
See |ale#engine#ManageFile()| and |ale#engine#ManageDirectory| for more
information.
+ *ale-command-format-strings*
+
All command strings will be formatted for special character sequences.
Any substring `%s` will be replaced with the full path to the current file
being edited. This format option can be used to pass the exact filename