summaryrefslogtreecommitdiff
path: root/src/keyboard.c
diff options
context:
space:
mode:
authorEli Zaretskii <eliz@gnu.org>2021-09-20 10:50:53 +0300
committerEli Zaretskii <eliz@gnu.org>2021-09-20 10:50:53 +0300
commitb34dcd96e909cc73ae0ff50215ac2c3f18b5ab30 (patch)
tree941717a57b22f8f53b13cfa1689f964a4522020b /src/keyboard.c
parent9e9db94423c0573edf283a0fc11f56d8d8025bf5 (diff)
downloademacs-b34dcd96e909cc73ae0ff50215ac2c3f18b5ab30.tar.gz
emacs-b34dcd96e909cc73ae0ff50215ac2c3f18b5ab30.tar.bz2
emacs-b34dcd96e909cc73ae0ff50215ac2c3f18b5ab30.zip
; * src/keyboard.c (Frecursive_edit): Minor fixes of the doc string.
Diffstat (limited to 'src/keyboard.c')
-rw-r--r--src/keyboard.c11
1 files changed, 6 insertions, 5 deletions
diff --git a/src/keyboard.c b/src/keyboard.c
index 2d97429ade2..bc6f97586dd 100644
--- a/src/keyboard.c
+++ b/src/keyboard.c
@@ -754,16 +754,17 @@ DEFUN ("recursive-edit", Frecursive_edit, Srecursive_edit, 0, 0, "",
To get out of the recursive edit, a command can throw to `exit' -- for
instance (throw \\='exit nil).
-The following values can be thrown to 'exit:
+The following values (last argument to `throw') can be used when
+throwing to \\='exit:
- t causes `recursive-edit' to quit, so that control returns to the
command loop one level up.
-- A string causes `recursive-edit' to signal an error, printing this
- string as the message.
+- A string causes `recursive-edit' to signal an error, printing that
+ string as the error message.
-- A function causes `recursive-edit' to call this function without
- arguments before returning normally.
+- A function causes `recursive-edit' to call that function with no
+ arguments, and then return normally.
- Any other value causes `recursive-edit' to return normally to the
function that called it.