summaryrefslogtreecommitdiff
path: root/doc/ale.txt
diff options
context:
space:
mode:
authorDavid Briscoe <idbrii@gmail.com>2022-02-04 03:22:40 -0800
committerGitHub <noreply@github.com>2022-02-04 20:22:40 +0900
commit6d20b6c1628bff0a0eeacd0bf02c0dd1463c3acb (patch)
tree4ebbd99e26c6621a89625fdda053141e1368db38 /doc/ale.txt
parent0d529d9b948d21065789c5670500cbfba5386f6f (diff)
downloadale-6d20b6c1628bff0a0eeacd0bf02c0dd1463c3acb.zip
doc: Clarify the types of process_with (#4039)
Diffstat (limited to 'doc/ale.txt')
-rw-r--r--doc/ale.txt14
1 files changed, 9 insertions, 5 deletions
diff --git a/doc/ale.txt b/doc/ale.txt
index c7c1e81b..c31e2d3b 100644
--- a/doc/ale.txt
+++ b/doc/ale.txt
@@ -364,12 +364,16 @@ are supported for running the commands.
`process_with` An optional callback for post-processing.
- The callback must accept two arguments,
- `(buffer, output)`, which can be used for converting
- the output from a command into lines to replace the
- buffer's contents with.
+ The callback must accept arguments `(bufnr, output)`:
+ the buffer number undergoing fixing and the fixer's
+ output as a |List| of |String|s. It must return a |List|
+ of |String|s that will be the new contents of the
+ buffer.
+
+ This callback is useful to remove excess lines from the
+ command's output or apply additional changes to the
+ output.
- A |List| of |String|s must be returned.
`read_buffer` An optional key for disabling reading the buffer.