From: Lars Ingebrigtsen <larsi@gnus.org>
To: emacs-devel@gnu.org
Subject: Re: Paragraph styles in doc strings
Date: Mon, 09 May 2016 17:42:10 +0200 [thread overview]
Message-ID: <87zirzi6gd.fsf@gnus.org> (raw)
In-Reply-To: <mvm37prdznd.fsf@hawking.suse.de> (Andreas Schwab's message of "Mon, 09 May 2016 17:22:46 +0200")
Andreas Schwab <schwab@suse.de> writes:
> This isn't a paragraph style, but a list style, only without bullet
> points or numbering. In a typeset document there wouldn't be extra
> space between the items.
Well, it's used as a paragraph style here and there... Here both also
both with and without with the "blank line" style. :-)
-----
(interactive &optional ARG-DESCRIPTOR)
Specify a way of parsing arguments for interactive use of a function.
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 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 command.
Just ‘(interactive)’ means pass no arguments to the command when
calling interactively.
--
(domestic pets only, the antidote for overdose, milk.)
bloggy blog: http://lars.ingebrigtsen.no
next prev parent reply other threads:[~2016-05-09 15:42 UTC|newest]
Thread overview: 19+ messages / expand[flat|nested] mbox.gz Atom feed top
2016-05-09 14:57 Paragraph styles in doc strings Lars Ingebrigtsen
2016-05-09 15:01 ` Dmitry Gutov
2016-05-09 15:07 ` Kaushal Modi
2016-05-11 1:52 ` John Wiegley
2016-05-12 20:37 ` Lars Ingebrigtsen
2016-05-16 20:53 ` Stefan Monnier
2016-06-01 23:01 ` Clément Pit--Claudel
2016-06-02 1:18 ` Stefan Monnier
2016-06-20 19:11 ` Clément Pit--Claudel
2016-06-21 1:18 ` Stefan Monnier
2016-06-21 3:24 ` Clément Pit--Claudel
2016-05-18 6:05 ` John Wiegley
2016-05-09 16:05 ` Drew Adams
2016-05-09 15:10 ` Paul Eggert
2016-05-09 15:48 ` Marcin Borkowski
2016-05-09 16:12 ` Paul Eggert
2016-05-09 15:22 ` Andreas Schwab
2016-05-09 15:42 ` Lars Ingebrigtsen [this message]
2016-05-09 15:45 ` Marcin Borkowski
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=87zirzi6gd.fsf@gnus.org \
--to=larsi@gnus.org \
--cc=emacs-devel@gnu.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this external index
https://git.savannah.gnu.org/cgit/emacs.git
https://git.savannah.gnu.org/cgit/emacs/org-mode.git
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.