summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorChris Marchesi <chrism@vancluevertech.com>2018-04-28 15:10:59 -0700
committerChris Marchesi <chrism@vancluevertech.com>2018-04-28 15:10:59 -0700
commitb81bc8d481c9967938118a0fffeb299b470cfd59 (patch)
treeee93a210a482eb98d8cf6a4a6ddab1126cf23be5 /README.md
parent11780e1d3d0da101eb7a313d1c4974ae2d5e323a (diff)
downloadale-b81bc8d481c9967938118a0fffeb299b470cfd59.zip
A couple of more doc fixes
* Update section 5.viii in the README with ALEJobStarted and re-format the example. * Add an extra line after documentation update to ensure consistency with the rest of the doc.
Diffstat (limited to 'README.md')
-rw-r--r--README.md16
1 files changed, 10 insertions, 6 deletions
diff --git a/README.md b/README.md
index dc397d05..53b6379c 100644
--- a/README.md
+++ b/README.md
@@ -524,17 +524,21 @@ Will give you:
### 5.viii. How can I execute some code when ALE starts or stops linting?
ALE runs its own [autocmd](http://vimdoc.sourceforge.net/htmldoc/autocmd.html)
-events when a lint or fix cycle are started and stopped. These events can be
-used to call arbitrary functions before and after ALE stops linting.
+events when a lint or fix cycle are started and stopped. There is also an event
+that runs when a linter job has been successfully started. These events can be
+used to call arbitrary functions during these respective parts of the ALE's
+operation.
```vim
augroup YourGroup
autocmd!
- autocmd User ALELintPre call YourFunction()
- autocmd User ALELintPost call YourFunction()
+ autocmd User ALELintPre call YourFunction()
+ autocmd User ALELintPost call YourFunction()
- autocmd User ALEFixPre call YourFunction()
- autocmd User ALEFixPost call YourFunction()
+ autocmd User ALEJobStarted call YourFunction()
+
+ autocmd User ALEFixPre call YourFunction()
+ autocmd User ALEFixPost call YourFunction()
augroup END
```