From mboxrd@z Thu Jan 1 00:00:00 1970 From: Bastien Subject: Re: Docstrings: Use of `C-u' Date: Mon, 16 Aug 2010 21:01:53 +0200 Message-ID: <87ocd24c0u.fsf@gnu.org> References: <0vhbizzap7.fsf@gmail.com> <87ocd71jz6.fsf@gmx.net> <87bp978cz8.fsf@mean.albasani.net> <87tymwreu6.fsf@mean.albasani.net> Mime-Version: 1.0 Content-Type: text/plain; charset=us-ascii Return-path: Received: from [140.186.70.92] (port=36243 helo=eggs.gnu.org) by lists.gnu.org with esmtp (Exim 4.43) id 1Ol4wY-0001Rp-2n for emacs-orgmode@gnu.org; Mon, 16 Aug 2010 15:01:59 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.69) (envelope-from ) id 1Ol4wV-00049i-RP for emacs-orgmode@gnu.org; Mon, 16 Aug 2010 15:01:57 -0400 Received: from mail-ww0-f49.google.com ([74.125.82.49]:52464) by eggs.gnu.org with esmtp (Exim 4.69) (envelope-from ) id 1Ol4wV-00049V-MS for emacs-orgmode@gnu.org; Mon, 16 Aug 2010 15:01:55 -0400 Received: by wwi14 with SMTP id 14so5481781wwi.30 for ; Mon, 16 Aug 2010 12:01:54 -0700 (PDT) In-Reply-To: <87tymwreu6.fsf@mean.albasani.net> (Memnon Anon's message of "Sun, 15 Aug 2010 01:41:21 +0200") List-Id: "General discussions about Org-mode." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Sender: emacs-orgmode-bounces+geo-emacs-orgmode=m.gmane.org@gnu.org Errors-To: emacs-orgmode-bounces+geo-emacs-orgmode=m.gmane.org@gnu.org To: Memnon Anon Cc: Markus Heller , emacs-orgmode@gnu.org Hi Memnon, Memnon Anon writes: > I found only one other example so far, which is different: > ,----[ org-agenda.el ] > | (defun org-agenda-set-restriction-lock (&optional type) > | "Set restriction lock for agenda, to current subtree or file. > | Restriction will be the file if TYPE is `file', or if type is the > * universal prefix '(4), or if the cursor is before the first headline > | in the file. Otherwise, restriction will be to the current subtree." > `---- > > Adding that the prefix argument will be interpretated as a *list of one* > integer like this -> '(4) seems great. This clarifies that the test > against the prefix argument is something like "(when (equal arg '(4))" > without looking at the code of the function itself. I agree beginners won't easily guess the prefix argument is of the form '(4). But as a beginner, I'd look for "prefix argument" in the Emacs manual and find this: http://www.gnu.org/s/emacs/manual/html_node/elisp/Prefix-Command-Arguments.html Or I'll ask this list :) In any case, I'm not sure clarification about this belongs to Org's code. Maybe we can just add a footnote in the Org's manual referring to the Emacs manual for the first important occurrence of "prefix argument" (one regarding a function that is very likely to be used in another function, or called in a lambda expression). Any suggestion? -- Bastien