emacs-diffs
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

master f8cc706fb3: Improve the execute-kbd-macro doc string


From: Lars Ingebrigtsen
Subject: master f8cc706fb3: Improve the execute-kbd-macro doc string
Date: Mon, 14 Mar 2022 07:17:32 -0400 (EDT)

branch: master
commit f8cc706fb3d1ba30715c09aac9654ba08aeeb5c9
Author: Lars Ingebrigtsen <larsi@gnus.org>
Commit: Lars Ingebrigtsen <larsi@gnus.org>

    Improve the execute-kbd-macro doc string
    
    * src/macros.c (Fexecute_kbd_macro): Improve the doc string
    (bug#14206).
---
 src/macros.c | 12 +++++++++---
 1 file changed, 9 insertions(+), 3 deletions(-)

diff --git a/src/macros.c b/src/macros.c
index 0447a367fd..6b6865d929 100644
--- a/src/macros.c
+++ b/src/macros.c
@@ -273,9 +273,15 @@ pop_kbd_macro (Lisp_Object info)
 }
 
 DEFUN ("execute-kbd-macro", Fexecute_kbd_macro, Sexecute_kbd_macro, 1, 3, 0,
-       doc: /* Execute MACRO as string of editor command characters.
-MACRO can also be a vector of keyboard events.  If MACRO is a symbol,
-its function definition is used.
+       doc: /* Execute MACRO as a sequence of events.
+If MACRO is a string or vector, then the events in it are executed
+exactly as if they had been input by the user.
+
+If MACRO is a symbol, its function definition is used.  If that is
+another symbol, this process repeats.  Eventually the result should be
+a string or vector.  If the result is not a symbol, string, or vector,
+an error is signaled.
+
 COUNT is a repeat count, or nil for once, or 0 for infinite loop.
 
 Optional third arg LOOPFUNC may be a function that is called prior to



reply via email to

[Prev in Thread] Current Thread [Next in Thread]