Close #2285 - Add a function for use with omnifunc

1 files changed, 13 insertions, 0 deletions

diff --git a/doc/ale.txt b/doc/ale.txt
index e445e914..7e6ac443 100644
--- a/doc/ale.txt
+++ b/doc/ale.txt
@@ -342,6 +342,12 @@ is loaded. The delay for completion can be configured with
 |g:ale_completion_delay|. This setting should not be enabled if you wish to
 use ALE as a completion source for other plugins.
 
+ALE provides an 'omnifunc' function |ale#completion#OmniFunc| for triggering
+completion manually with CTRL-X CTRL-O. |i_CTRL-X_CTRL-O| >
+
+  " Use ALE's function for omnicompletion.
+  set omnifunc=ale#completion#OmniFunc
+<
 ALE will only suggest so many possible matches for completion. The maximum
 number of items can be controlled with |g:ale_completion_max_suggestions|.
 
@@ -2790,6 +2796,13 @@ ale#command#ManageFile(buffer, filename)             *ale#command#ManageFile()*
   manages directories separately with the |ale#command#ManageDirectory| function.
 
 
+ale#completion#OmniFunc(findstart, base)            *ale#completion#OmniFunc()*
+
+  A completion function to use with 'omnifunc'.
+
+  See |ale-completion|.
+
+
 ale#engine#GetLoclist(buffer)                         *ale#engine#GetLoclist()*
 
   Given a buffer number, this function will return the list of problems