mirror/emacs
1
0
Fork 0
mirror of https://git.savannah.gnu.org/git/emacs.git synced 2024-12-21 10:24:55 +00:00
Code Issues Releases Activity

Clarify the `interactive' doc string slightly

Browse Source 
* src/callint.c (Finteractive): Clarify the doc string slightly
  (bug#14577).

(cherry picked from commit cd993be60d)
This commit is contained in:
Lars Ingebrigtsen 2016-04-29 00:17:50 +02:00
parent 0a14d84150
commit cf33ae0c12
1 changed files with 16 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
src/callint.c
View File

@ -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)
{