aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRadon Rosborough <radon.neon@gmail.com>2022-04-17 11:59:32 -0700
committerRadon Rosborough <radon.neon@gmail.com>2022-04-17 11:59:32 -0700
commit9804f241ac8235027ea91a49d3c6275ecbaae203 (patch)
tree432d02379703c401e6a66118a5fb6c449b62f72c
parent806210414b84549f1c19d2df94a4a0491a581f2f (diff)
[#86] Update outdated docstring
Closes #86
-rw-r--r--apheleia.el12
1 files changed, 4 insertions, 8 deletions
diff --git a/apheleia.el b/apheleia.el
index 83329a6..854cc5c 100644
--- a/apheleia.el
+++ b/apheleia.el
@@ -929,14 +929,10 @@ The keys may be any symbols you want, and the values are
shell commands, lists of strings and symbols, or a function
symbol.
-If the value is a function, the function will be called with four
-arguments to format the current buffer: the original buffer that
-was being formatted (use this to access any relevent local
-variables or options that the formatter needs); a clone of the
-original buffer (that may have been modified by another formatter
-prior to being passed to the function); a callback that should be
-called when formatting is finished; and another callback that
-should be called when an error was raised during formatting.
+If the value is a function, the function will be called with
+keyword arguments (see the implementation of
+`apheleia--run-formatter-function' to see which). It should use
+`cl-defun' with `&allow-other-keys' for forward compatibility.
Otherwise in Lisp code, the format of commands is similar to what
you pass to `make-process', except as follows.