diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/ale.txt | 12 |
1 files changed, 8 insertions, 4 deletions
diff --git a/doc/ale.txt b/doc/ale.txt index 0b127725..64a4f439 100644 --- a/doc/ale.txt +++ b/doc/ale.txt @@ -675,10 +675,14 @@ The values for `g:ale_fixers` can be a list of |String|, |Funcref|, or for a function set in the ALE fixer registry. Each function for fixing errors must accept either one argument `(buffer)` or -two arguments `(buffer, lines)`, representing the buffer being fixed and the -lines to fix. The functions must return either `0`, for changing nothing, a -|List| for new lines to set, or a |Dictionary| for describing a command to be -run in the background. +three arguments `(buffer, done, lines)`, representing the buffer being fixed, +a function to call with results, and the lines to fix. The functions must +return either `0`, for changing nothing, a |List| for new lines to set, a +|Dictionary| for describing a command to be run in the background, or `v:true` +for indicating that results will be provided asynchronously via the `done` +callback. + +NOTE: The `done` function has not been implemented yet. Functions receiving a variable number of arguments will not receive the second argument `lines`. Functions should name two arguments if the `lines` argument |