From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!not-for-mail From: "Richard M. Stallman" Newsgroups: gmane.emacs.devel Subject: Re: Suggestions for the temporary windows used from the minibuffer Date: Tue, 09 Aug 2005 11:19:24 -0400 Message-ID: References: <42F34A82.9070703@student.lu.se> <42F3F3D7.7060506@student.lu.se> <42F68B76.7030109@student.lu.se> Reply-To: rms@gnu.org NNTP-Posting-Host: main.gmane.org Content-Type: text/plain; charset=ISO-8859-15 X-Trace: sea.gmane.org 1123601723 18684 80.91.229.2 (9 Aug 2005 15:35:23 GMT) X-Complaints-To: usenet@sea.gmane.org NNTP-Posting-Date: Tue, 9 Aug 2005 15:35:23 +0000 (UTC) Cc: emacs-devel@gnu.org Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Tue Aug 09 17:35:22 2005 Return-path: Original-Received: from lists.gnu.org ([199.232.76.165]) by ciao.gmane.org with esmtp (Exim 4.43) id 1E2W7B-0005ln-6T for ged-emacs-devel@m.gmane.org; Tue, 09 Aug 2005 17:34:06 +0200 Original-Received: from localhost ([127.0.0.1] helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.43) id 1E2WAE-0002nz-6k for ged-emacs-devel@m.gmane.org; Tue, 09 Aug 2005 11:37:14 -0400 Original-Received: from mailman by lists.gnu.org with tmda-scanned (Exim 4.43) id 1E2W6u-0001sC-Td for emacs-devel@gnu.org; Tue, 09 Aug 2005 11:33:49 -0400 Original-Received: from exim by lists.gnu.org with spam-scanned (Exim 4.43) id 1E2W6i-0001lQ-8k for emacs-devel@gnu.org; Tue, 09 Aug 2005 11:33:41 -0400 Original-Received: from [199.232.76.173] (helo=monty-python.gnu.org) by lists.gnu.org with esmtp (Exim 4.43) id 1E2W6h-0001io-BA for emacs-devel@gnu.org; Tue, 09 Aug 2005 11:33:35 -0400 Original-Received: from [199.232.76.164] (helo=fencepost.gnu.org) by monty-python.gnu.org with esmtp (Exim 4.34) id 1E2W8u-0005oB-GK for emacs-devel@gnu.org; Tue, 09 Aug 2005 11:35:52 -0400 Original-Received: from rms by fencepost.gnu.org with local (Exim 4.34) id 1E2Vsy-0005Rk-VL; Tue, 09 Aug 2005 11:19:25 -0400 Original-To: Lennart Borgman In-reply-to: <42F68B76.7030109@student.lu.se> (message from Lennart Borgman on Mon, 08 Aug 2005 00:30:14 +0200) X-BeenThere: emacs-devel@gnu.org X-Mailman-Version: 2.1.5 Precedence: list List-Id: "Emacs development discussions." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Original-Sender: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Errors-To: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Xref: news.gmane.org gmane.emacs.devel:41797 +When calling FNAME if the optional parameters X-FUNCTION, X-CHAR +and X-DESCRIPTION to the defined function FNAME are given they +must all be given. In this case the the sequence +`%X-DESCRIPTION%' in HELP-TEXT is replaced with the parameters +X-CHAR character and the X-DESCRIPTION string. Also the keyboard +character X-CHAR is bound to the parameter X-FUNCTION. I don't understand that text; I am simply lost. You need to state it more clearly. The best place for this info is in the doc string of the constructed function that will take these arguments. Moving the text there will help you simplify the text. However, part of the reason this is confusing is that the explanation states the algorithm for USING these arguments. What it needs to say is WHAT THEY MEAN. Documentation should not read like a program logic manual. + (mapc (lambda (elt) + (let ((new (if (consp elt) (cdr elt) elt)) + (orig (if (consp elt) (car elt) elt))) + (mapc (lambda (key) + (define-key still-map key new)) + (where-is-internal orig)))) + still-lst) That code needs a comment to explain what it is doing.