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: Fri, 07 May 2004 10:39:47 +0200 Sender: emacs-devel-bounces+emacs-devel=quimby.gnus.org@gnu.org Message-ID: <20040507102604.2132.JMBARRANQUERO@wke.es> References: 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 1083919397 17457 80.91.224.253 (7 May 2004 08:43:17 GMT) X-Complaints-To: usenet@sea.gmane.org NNTP-Posting-Date: Fri, 7 May 2004 08:43:17 +0000 (UTC) Original-X-From: emacs-devel-bounces+emacs-devel=quimby.gnus.org@gnu.org Fri May 07 10:43:06 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 1BM0wj-0007SQ-00 for ; Fri, 07 May 2004 10:43:05 +0200 Original-Received: from monty-python.gnu.org ([199.232.76.173]) by quimby.gnus.org with esmtp (Exim 3.35 #1 (Debian)) id 1BM0wj-0000kT-00 for ; Fri, 07 May 2004 10:43:05 +0200 Original-Received: from localhost ([127.0.0.1] helo=monty-python.gnu.org) by monty-python.gnu.org with esmtp (Exim 4.30) id 1BM0vt-0008Gx-L6 for emacs-devel@quimby.gnus.org; Fri, 07 May 2004 04:42:13 -0400 Original-Received: from list by monty-python.gnu.org with tmda-scanned (Exim 4.30) id 1BM0v2-0007Qe-Co for emacs-devel@gnu.org; Fri, 07 May 2004 04:41:20 -0400 Original-Received: from mail by monty-python.gnu.org with spam-scanned (Exim 4.30) id 1BM0uG-0006NC-FA for emacs-devel@gnu.org; Fri, 07 May 2004 04:41:06 -0400 Original-Received: from [62.22.181.117] (helo=idefix.laley.net) by monty-python.gnu.org with esmtp (Exim 4.30) id 1BM0th-0005OB-Lr; Fri, 07 May 2004 04:39:57 -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 JN3LMC9C; Fri, 7 May 2004 10:39:05 +0200 Original-To: Miles Bader , emacs-devel@gnu.org In-Reply-To: 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:22899 X-Report-Spam: http://spam.gmane.org/gmane.emacs.devel:22899 On 07 May 2004 14:32:46 +0900 Miles Bader wrote: > I've just seen the effect of the argument highlighting in > describe-function *Help* buffers, and it seems like _way_ too much. > It's nice to have some highlighting for the args, but I think > `font-lock-variable-name-face' is the wrong thing to use. Not only I fully agree with you, but one or two days ago I changed it to use (:face '(:weight bold)), which seems much more sensible as a default... :) The font-lock-variable-name-face was just a test version. > I ended up thinking `the arguments are _already_ in uppercase, which is > pretty noticeable, why is necessary to highlight them further at all?' There are several reasons: - Many docstrings have other uppercase words (for example, most def* functions, like defface, define-minor-mode, defcustom...), so the highlighting helps to distinguish which ones are really function arguments. - It makes easier to look for an argument when the docstring is long. - The feature can be used to highlight just *one* (or a set of) argument. That could help in places where we're asking for input for an argument and want to show the entire docstring, but highlight the item we're requesting (that's the original motivation). Help argument highlighting has proved already very useful to find docstrings with typos in argument names, or which use a different name in the arglist and the docstring. My (admitedly *very* biased opinion :) is that some people finds the feature useful, so I suggest that, instead of removing it, thoso who don't like it set the face to default. Juanma