From: Lars Ingebrigtsen <larsi@gnus.org>
Date: Mon, 14 Mar 2022 11:16:27 +0000 (+0100)
Subject: Improve the execute-kbd-macro doc string
X-Git-Tag: emacs-29.0.90~1931^2~1132
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=f8cc706fb3d1ba30715c09aac9654ba08aeeb5c9;p=emacs.git

Improve the execute-kbd-macro doc string

* src/macros.c (Fexecute_kbd_macro): Improve the doc string
(bug#14206).
---

diff --git a/src/macros.c b/src/macros.c
index 0447a367fd6..6b6865d9298 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