summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorw0rp <devw0rp@gmail.com>2017-04-24 22:40:15 +0100
committerw0rp <devw0rp@gmail.com>2017-04-24 22:40:15 +0100
commit3345bf20ca92d75e80bae880030268ae49890f6c (patch)
treeadc6794fccae2ce74fd2fb3e08212a57a114713c
parenta03121f5b051ed1f146a8979ea5d2bb26fe05bff (diff)
downloadale-3345bf20ca92d75e80bae880030268ae49890f6c.zip
Fix #450 Document how linters are loaded
-rw-r--r--doc/ale.txt12
1 files changed, 12 insertions, 0 deletions
diff --git a/doc/ale.txt b/doc/ale.txt
index bb21035c..8f3476bd 100644
--- a/doc/ale.txt
+++ b/doc/ale.txt
@@ -911,6 +911,18 @@ ale#linter#Define(filetype, linter) *ale#linter#Define()*
is not desired, the |ale#engine#EscapeCommandPart()| function can be used to
replace those characters to avoid formatting issues.
+ *ale-linter-loading-behaviour*
+
+ Linters for ALE will be loaded by searching |runtimepath| in the following
+ format: >
+
+ ale_linters/<filetype>/<linter_name>.vim
+<
+ Any linters which exist anywhere in |runtimepath| with that directory
+ structure will be automatically loaded for the matching |filetype|. Filetypes
+ containing `.` characters will be split into individual parts, and files
+ will be loaded for each filetype between the `.` characters.
+
ale#linter#Get(filetype) *ale#linter#Get()*