[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[nongnu] elpa/helm 21a3a0cf8b 3/4: Update helm-command-with-subkeys docs
From: |
ELPA Syncer |
Subject: |
[nongnu] elpa/helm 21a3a0cf8b 3/4: Update helm-command-with-subkeys docstring |
Date: |
Sat, 5 Aug 2023 15:59:38 -0400 (EDT) |
branch: elpa/helm
commit 21a3a0cf8b969915b0d08cf804b403972612b0f3
Author: Thierry Volpiatto <thievol@posteo.net>
Commit: Thierry Volpiatto <thievol@posteo.net>
Update helm-command-with-subkeys docstring
---
helm-core.el | 13 ++++++++++++-
1 file changed, 12 insertions(+), 1 deletion(-)
diff --git a/helm-core.el b/helm-core.el
index 422bd03b94..607f4968ed 100644
--- a/helm-core.el
+++ b/helm-core.el
@@ -270,7 +270,18 @@ and second call within 1s runs `helm-swap-windows'."
(defun helm-command-with-subkeys (map subkey command
&optional other-subkeys prompt exit-fn delay)
- "Return an anonymous interactive command to use with
`helm-define-key-with-subkeys'."
+ "Build a command that run COMMAND when SUBKEY is read.
+
+The command runs a loop reading keys and exit when user stops typing after
DELAY
+seconds. After this DELAY EXIT-FN run if specified.
+
+Arg OTHER-SUBKEYS should be an alist composed of (command . short-key) where
+command is another command than COMMAND bound to short-key.
+
+A PROMPT can be used to describe bindings of COMMAND and OTHER-SUBKEYS.
+
+Return an anonymous interactive command to use with
+`helm-define-key-with-subkeys'."
(lambda ()
(interactive)
(let (timer)