jshaver
/
ale
forked from github-mirrors/ale
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

doc: Clarify the types of process_with (#4039)

This commit is contained in:
David Briscoe 2022-02-04 03:22:40 -08:00 committed by GitHub
parent 0d529d9b94
commit 6d20b6c162
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 9 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
doc/ale.txt
View File

@ -364,12 +364,16 @@ are supported for running the commands.
`process_with` An optional callback for post-processing. `process_with` An optional callback for post-processing.
The callback must accept two arguments, The callback must accept arguments `(bufnr, output)`:
`(buffer, output)`, which can be used for converting the buffer number undergoing fixing and the fixer's
the output from a command into lines to replace the output as a |List| of |String|s. It must return a |List|
buffer's contents with. 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. `read_buffer` An optional key for disabling reading the buffer.