summaryrefslogtreecommitdiff
path: root/src/callint.c
diff options
context:
space:
mode:
authorLars Ingebrigtsen <larsi@gnus.org>2016-04-29 00:17:50 +0200
committerLars Ingebrigtsen <larsi@gnus.org>2016-05-01 19:27:07 +0200
commitcf33ae0c1286efb7acee8b1c0076048d5d3e3543 (patch)
tree24a53cecc30d9d0e224593d491a79debfbe58d77 /src/callint.c
parent0a14d84150e7728ff1461d3f25b1b5bdc6e0cf08 (diff)
downloademacs-cf33ae0c1286efb7acee8b1c0076048d5d3e3543.tar.gz
Clarify the `interactive' doc string slightly
* src/callint.c (Finteractive): Clarify the doc string slightly (bug#14577). (cherry picked from commit cd993be60da2d12db0d390001373d486c1091c47)
Diffstat (limited to 'src/callint.c')
-rw-r--r--src/callint.c30
1 files changed, 17 insertions, 13 deletions
diff --git a/src/callint.c b/src/callint.c
index 3bcf2c8476b..e56f7cd1b84 100644
--- a/src/callint.c
+++ b/src/callint.c
@@ -41,20 +41,24 @@ For example, write
(defun foo (arg buf) "Doc string" (interactive "P\\nbbuffer: ") .... )
to make ARG be the raw prefix argument, and set BUF to an existing buffer,
when `foo' is called as a command.
-The "call" to `interactive' is actually a declaration rather than a function;
- it tells `call-interactively' how to read arguments
- to pass to the function.
-When actually called, `interactive' just returns nil.
-
-Usually the argument of `interactive' is a string containing a code letter
- followed optionally by a prompt. (Some code letters do not use I/O to get
- the argument and do not use prompts.) To get several arguments, concatenate
- the individual strings, separating them by newline characters.
-Prompts are passed to format, and may use % escapes to print the
+
+The "call" to `interactive' is actually a declaration rather than a
+ function; it tells `call-interactively' how to read arguments to pass
+ to the function. When actually called, `interactive' just returns
+ nil.
+
+Usually the argument of `interactive' is a string containing a code
+ letter followed optionally by a prompt. (Some code letters do not
+ use I/O to get the argument and do not use prompts.) To pass several
+ arguments to the command, concatenate the individual strings,
+ separating them by newline characters.
+
+Prompts are passed to `format', and may use % escapes to print the
arguments that have already been read.
If the argument is not a string, it is evaluated to get a list of
- arguments to pass to the function.
-Just `(interactive)' means pass no args when calling interactively.
+ arguments to pass to the command.
+Just `(interactive)' means pass no arguments to the command when
+ calling interactively.
Code letters available are:
a -- Function name: symbol with a function definition.
@@ -99,7 +103,7 @@ If the string begins with `^' and `shift-select-mode' is non-nil,
Emacs first calls the function `handle-shift-selection'.
You may use `@', `*', and `^' together. They are processed in the
order that they appear, before reading any arguments.
-usage: (interactive &optional ARGS) */
+usage: (interactive &optional ARG-DESCRIPTOR) */
attributes: const)
(Lisp_Object args)
{