From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!not-for-mail From: Lars Ingebrigtsen Newsgroups: gmane.emacs.devel Subject: Re: Paragraph styles in doc strings Date: Mon, 09 May 2016 17:42:10 +0200 Message-ID: <87zirzi6gd.fsf@gnus.org> References: <878tzjjn3w.fsf@gnus.org> NNTP-Posting-Host: plane.gmane.org Mime-Version: 1.0 Content-Type: text/plain; charset=windows-1252 Content-Transfer-Encoding: quoted-printable X-Trace: ger.gmane.org 1462808811 9131 80.91.229.3 (9 May 2016 15:46:51 GMT) X-Complaints-To: usenet@ger.gmane.org NNTP-Posting-Date: Mon, 9 May 2016 15:46:51 +0000 (UTC) To: emacs-devel@gnu.org Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Mon May 09 17:46:40 2016 Return-path: Envelope-to: ged-emacs-devel@m.gmane.org Original-Received: from lists.gnu.org ([208.118.235.17]) by plane.gmane.org with esmtp (Exim 4.69) (envelope-from ) id 1aznKF-0002S0-8J for ged-emacs-devel@m.gmane.org; Mon, 09 May 2016 17:42:27 +0200 Original-Received: from localhost ([::1]:41955 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1aznKC-0004AY-Dx for ged-emacs-devel@m.gmane.org; Mon, 09 May 2016 11:42:24 -0400 Original-Received: from eggs.gnu.org ([2001:4830:134:3::10]:60895) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1aznK7-00047Y-DH for emacs-devel@gnu.org; Mon, 09 May 2016 11:42:20 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1aznK3-0000tF-4c for emacs-devel@gnu.org; Mon, 09 May 2016 11:42:18 -0400 Original-Received: from hermes.netfonds.no ([80.91.224.195]:54111) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1aznK2-0000t4-NF for emacs-devel@gnu.org; Mon, 09 May 2016 11:42:15 -0400 Original-Received: from cm-84.215.1.64.getinternet.no ([84.215.1.64] helo=mouse) by hermes.netfonds.no with esmtpsa (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.84_2) (envelope-from ) id 1aznJy-0004FM-9m for emacs-devel@gnu.org; Mon, 09 May 2016 17:42:12 +0200 In-Reply-To: (Andreas Schwab's message of "Mon, 09 May 2016 17:22:46 +0200") User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/25.1.50 (gnu/linux) X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] X-Received-From: 80.91.224.195 X-BeenThere: emacs-devel@gnu.org X-Mailman-Version: 2.1.21 Precedence: list List-Id: "Emacs development discussions." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Original-Sender: "Emacs-devel" Xref: news.gmane.org gmane.emacs.devel:203719 Archived-At: Andreas Schwab 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 =91foo=92 is called as a command. The "call" to =91interactive=92 is actually a declaration rather than a function; it tells =91call-interactively=92 how to read arguments to pass to the function. When actually called, =91interactive=92 just returns nil. Usually the argument of =91interactive=92 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 =91format=92, 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 =91(interactive)=92 means pass no arguments to the command when calling interactively. --=20 (domestic pets only, the antidote for overdose, milk.) bloggy blog: http://lars.ingebrigtsen.no