diff options
| author | Niraj Thapaliya <nthapaliya@users.noreply.github.com> | 2017-12-26 12:00:28 -0600 |
|---|---|---|
| committer | Niraj Thapaliya <nthapaliya@users.noreply.github.com> | 2017-12-26 14:10:28 -0600 |
| commit | c90b45c559342f22fdeee9e8ace0927406aa4b0b (patch) | |
| tree | 1e835343cf4c8b84a2a13471bb21887bdc51e737 /doc | |
| parent | e2d3dca48644136d62346d45d8b031a138e18700 (diff) | |
| download | ale-c90b45c559342f22fdeee9e8ace0927406aa4b0b.zip | |
Edit README and help
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/ale-fish.txt | 14 | ||||
| -rw-r--r-- | doc/ale.txt | 2 |
2 files changed, 16 insertions, 0 deletions
diff --git a/doc/ale-fish.txt b/doc/ale-fish.txt new file mode 100644 index 00000000..8450b38a --- /dev/null +++ b/doc/ale-fish.txt @@ -0,0 +1,14 @@ +=============================================================================== +ALE Fish Integration *ale-fish-options* + +Lints fish files using `fish -n`. + +Note that `fish -n` is not foolproof: it sometimes gives false positives or +errors that are difficult to parse without more context. This integration skips +displaying errors if an error message is not found. + +If ALE is not showing any errors but your file does not run as expected, run +`fish -n <file.fish>` from the command line. + +=============================================================================== + vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl: diff --git a/doc/ale.txt b/doc/ale.txt index bec086d1..ce6ae6bb 100644 --- a/doc/ale.txt +++ b/doc/ale.txt @@ -64,6 +64,7 @@ CONTENTS *ale-contents* erlc................................|ale-erlang-erlc| syntaxerl...........................|ale-erlang-syntaxerl| eruby.................................|ale-eruby-options| + fish..................................|ale-fish-options| fortran...............................|ale-fortran-options| gcc.................................|ale-fortran-gcc| fusionscript..........................|ale-fuse-options| @@ -300,6 +301,7 @@ Notes: * Elm: `elm-format, elm-make` * Erb: `erb`, `erubis` * Erlang: `erlc`, `SyntaxErl` +* Fish: `fish` (-n flag) * Fortran: `gcc` * FusionScript: `fusion-lint` * Git Commit Messages: `gitlint` |