branch: externals/consult
commit 3226c1a01e0a2a4352b2c885b8f4eb22610d99af
Author: Daniel Mendler <m...@daniel-mendler.de>
Commit: Daniel Mendler <m...@daniel-mendler.de>
Expand docstring of consult-customize
---
consult.el | 9 ++++++---
1 file changed, 6 insertions(+), 3 deletions(-)
diff --git a/consult.el b/consult.el
index 1f0d360a1c..87bb070347 100644
--- a/consult.el
+++ b/consult.el
@@ -544,9 +544,12 @@ We use invalid characters outside the Unicode range.")
(defmacro consult-customize (&rest args)
"Set properties of commands or sources.
-ARGS is a list of commands or sources followed by the list of keyword-value
-pairs."
- (let ((setter))
+ARGS is a list of commands or sources followed by the list of
+keyword-value pairs. For `consult-customize' to succeed, the
+customized sources and commands must exist. When a command is
+invoked, the value of `this-command' is used to lookup the
+corresponding customization options."
+ (let (setter)
(while args
(let ((cmds (seq-take-while (lambda (x) (not (keywordp x))) args)))
(setq args (seq-drop-while (lambda (x) (not (keywordp x))) args))
