From b81bc8d481c9967938118a0fffeb299b470cfd59 Mon Sep 17 00:00:00 2001 From: Chris Marchesi Date: Sat, 28 Apr 2018 15:10:59 -0700 Subject: [PATCH] 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. --- README.md | 16 ++++++++++------ doc/ale.txt | 1 + 2 files changed, 11 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 ``` diff --git a/doc/ale.txt b/doc/ale.txt index 3252fc6b..41a177a4 100644 --- a/doc/ale.txt +++ b/doc/ale.txt @@ -2461,6 +2461,7 @@ ALEJobStarted *ALEJobStarted-autocmd* |ale#engine#IsCheckingBuffer()| over |ALELintPre-autocmd|, which is actually triggered before any linters are executed. + =============================================================================== 10. Special Thanks *ale-special-thanks*