hasufell
/
ale
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Add some more tags to the documentation, for easy references

This commit is contained in:
w0rp 2017-04-23 18:06:26 +01:00
parent c1a2d26711
commit 9238976522
1 changed files with 4 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
doc/ale.txt
View File

@ -794,6 +794,7 @@ ale#linter#Define(filetype, linter) *ale#linter#Define()*
This can be used for skipping a linter call, This can be used for skipping a linter call,
say if no configuration file was found. say if no configuration file was found.
*ale-command-chain*
`command_chain` A |List| of |Dictionary| items defining a series `command_chain` A |List| of |Dictionary| items defining a series
of commands to be run. At least one |Dictionary| of commands to be run. At least one |Dictionary|
should be provided. Each Dictionary must contain the 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 if a command manually reads from a temporary file
instead, etc. instead, etc.
*ale-lint-file*
`lint_file` A |Number| (`0` or `1`) indicating whether a command `lint_file` A |Number| (`0` or `1`) indicating whether a command
should read the file instead of the Vim buffer. This should read the file instead of the Vim buffer. This
option can be used for linters which must check the 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 See |ale#engine#ManageFile()| and |ale#engine#ManageDirectory| for more
information. information.
*ale-command-format-strings*
All command strings will be formatted for special character sequences. All command strings will be formatted for special character sequences.
Any substring `%s` will be replaced with the full path to the current file 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 being edited. This format option can be used to pass the exact filename