branch: externals/consult
commit 2105d0bbace14f22a9e1864920af84e5f9c454d9
Author: Daniel Mendler <[email protected]>
Commit: Daniel Mendler <[email protected]>
consult--define-state: Add docstring
---
consult.el | 2 ++
1 file changed, 2 insertions(+)
diff --git a/consult.el b/consult.el
index 3aaf643215..6dc642c783 100644
--- a/consult.el
+++ b/consult.el
@@ -1364,6 +1364,8 @@ FACE is the cursor face."
(defmacro consult--define-state (type)
"Define state function for TYPE."
`(defun ,(intern (format "consult--%s-state" type)) ()
+ ,(format "State function for %ss with preview.
+The result can be passed as :state argument to `consult--read'." type)
(consult--state-with-return (,(intern (format "consult--%s-preview"
type)))
#',(intern (format "consult--%s-action"
type)))))
