summaryrefslogtreecommitdiff
path: root/doc/ale-fish.txt
diff options
context:
space:
mode:
Diffstat (limited to 'doc/ale-fish.txt')
-rw-r--r--doc/ale-fish.txt14
1 files changed, 14 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: