diff options
| author | Lars Ingebrigtsen <larsi@gnus.org> | 2016-04-29 00:17:50 +0200 |
|---|---|---|
| committer | Lars Ingebrigtsen <larsi@gnus.org> | 2016-04-29 00:17:50 +0200 |
| commit | cd993be60da2d12db0d390001373d486c1091c47 (patch) | |
| tree | 97ef22da3ffcdf2a8c879198626245ef9bbca128 /src | |
| parent | 65797b1d75e9f608ffd50fd88be47a854b143bb1 (diff) | |
Clarify the `interactive' doc string slightly
* src/callint.c (Finteractive): Clarify the doc string slightly
(bug#14577).
Diffstat (limited to 'src')
| -rw-r--r-- | src/callint.c | 28 |
1 files changed, 16 insertions, 12 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) { |
