From mboxrd@z Thu Jan 1 00:00:00 1970 Path: main.gmane.org!not-for-mail From: Juanma Barranquero Newsgroups: gmane.emacs.devel Subject: Re: new *Help* argument highlighting Date: Tue, 11 May 2004 10:11:35 +0200 Sender: emacs-devel-bounces+emacs-devel=quimby.gnus.org@gnu.org Message-ID: <20040511100137.75F6.JMBARRANQUERO@wke.es> References: <20040511000920.AE85.LEKTU@mi.madritel.es> <20040510222621.GC12917@fencepost> NNTP-Posting-Host: deer.gmane.org Mime-Version: 1.0 Content-Type: text/plain; charset="US-ASCII" Content-Transfer-Encoding: 7bit X-Trace: sea.gmane.org 1084263899 27779 80.91.224.253 (11 May 2004 08:24:59 GMT) X-Complaints-To: usenet@sea.gmane.org NNTP-Posting-Date: Tue, 11 May 2004 08:24:59 +0000 (UTC) Cc: Miles Bader Original-X-From: emacs-devel-bounces+emacs-devel=quimby.gnus.org@gnu.org Tue May 11 10:24:47 2004 Return-path: Original-Received: from quimby.gnus.org ([80.91.224.244]) by deer.gmane.org with esmtp (Exim 3.35 #1 (Debian)) id 1BNSZD-0002as-00 for ; Tue, 11 May 2004 10:24:47 +0200 Original-Received: from monty-python.gnu.org ([199.232.76.173]) by quimby.gnus.org with esmtp (Exim 3.35 #1 (Debian)) id 1BNSZD-000717-00 for ; Tue, 11 May 2004 10:24:47 +0200 Original-Received: from localhost ([127.0.0.1] helo=monty-python.gnu.org) by monty-python.gnu.org with esmtp (Exim 4.34) id 1BNSQf-0007cm-A7 for emacs-devel@quimby.gnus.org; Tue, 11 May 2004 04:15:57 -0400 Original-Received: from list by monty-python.gnu.org with tmda-scanned (Exim 4.34) id 1BNSNO-0007Hj-KS for emacs-devel@gnu.org; Tue, 11 May 2004 04:12:35 -0400 Original-Received: from mail by monty-python.gnu.org with spam-scanned (Exim 4.34) id 1BNSMj-00077S-Im for emacs-devel@gnu.org; Tue, 11 May 2004 04:12:25 -0400 Original-Received: from [62.22.181.117] (helo=idefix.laley.net) by monty-python.gnu.org with esmtp (Exim 4.34) id 1BNSMa-00071s-PL; Tue, 11 May 2004 04:11:45 -0400 Original-Received: from [172.17.221.23] (jsredondo.wk.org [172.17.221.23]) by idefix.laley.net with SMTP (Microsoft Exchange Internet Mail Service Version 5.5.2655.55) id K4TS1F7L; Tue, 11 May 2004 10:11:32 +0200 Original-To: emacs-devel@gnu.org In-Reply-To: <20040510222621.GC12917@fencepost> X-Mailer: Becky! ver. 2.08.01 [en] X-BeenThere: emacs-devel@gnu.org X-Mailman-Version: 2.1.4 Precedence: list List-Id: "Emacs development discussions." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: emacs-devel-bounces+emacs-devel=quimby.gnus.org@gnu.org Xref: main.gmane.org gmane.emacs.devel:23118 X-Report-Spam: http://spam.gmane.org/gmane.emacs.devel:23118 On Mon, 10 May 2004 18:26:21 -0400 Miles Bader wrote: > Still, it seems like a very nice way of presenting the arguments -- easy to > read, less SHOUTY than the old method, and more consistent with the printed > documentation[*]. Yes, I think is the best one suggested so far. > I'd be happy if there was (as you suggested) a variable > holding a filter-function that help would call to munge the args, which by > default would downcase-and-italicize them. That's my preferred solution too, so people can even do (defun my-arg-highlight (arg) (propertize (downcase arg) 'display '(size (+ 1)) 'face '(:weight bold))) which is not possible with a face. > 99.9% of the users won't ever change either one, so I think the nicer > display would be worth the small amount of added complexity for those who do > want to change something. Agreed. Aside: for this to work, docstring writers still have to use the ALLCAPS convention for arguments; I wonder if we could introduce (sometime after 21.[45], obviously :) a new (additional) convention to mark arguments in the docstring, so less guesswork is needed. Of course, it wouldn't be necessary to go back to change all existing docstrings (the current guessing method would still work), but just adding the new convention to a few complex ones would be a gain. Juanma