Merge commit '76265755a1add77121c8f9dabb3e9bb70fe9a972' as '.vim/bundle/ale'

[etc/vim.git] / .vim / bundle / ale / doc / ale-text.txt

diff --git a/.vim/bundle/ale/doc/ale-text.txt b/.vim/bundle/ale/doc/ale-text.txt
new file mode 100644 (file)
index 0000000..da2d9b4
--- /dev/null
+++ b/.vim/bundle/ale/doc/ale-text.txt
@@ -0,0 +1,55 @@
+===============================================================================
+ALE Text Integration                                         *ale-text-options*
+
+
+==============================================================================
+cspell                                                        *ale-text-cspell*
+
+See |ale-cspell-options|
+
+
+===============================================================================
+textlint                                                    *ale-text-textlint*
+
+The options for the textlint linter are global because it does not make
+sense to have them specified on a per-language basis.
+
+                                              *ale-options.textlint_executable*
+                                                    *g:ale_textlint_executable*
+                                                    *b:ale_textlint_executable*
+textlint_executable
+g:ale_textlint_executable
+  Type: |String|
+  Default: `'textlint'`
+
+  See |ale-integrations-local-executables|
+
+                                                 *ale-options.textlint_options*
+                                                       *g:ale_textlint_options*
+                                                       *b:ale_textlint_options*
+textlint_options
+g:ale_textlint_options
+  Type: |String|
+  Default: `''`
+
+  This variable can be set to pass additional options to textlint.
+
+                                              *ale-options.textlint_use_global*
+                                                    *g:ale_textlint_use_global*
+                                                    *b:ale_textlint_use_global*
+textlint_use_global
+g:ale_textlint_use_global
+  Type: |Number|
+  Default: `get(g:, 'ale_use_global_executables', 0)`
+
+  See |ale-integrations-local-executables|
+
+
+===============================================================================
+write-good                                                *ale-text-write-good*
+
+See |ale-write-good-options|
+
+
+===============================================================================
+  vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl: