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: Mon, 10 May 2004 09:37:41 +0200 Sender: emacs-devel-bounces+emacs-devel=quimby.gnus.org@gnu.org Message-ID: <20040510092433.5C7F.JMBARRANQUERO@wke.es> References: <20040510023212.F99D.LEKTU@mi.madritel.es> 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 1084175801 8579 80.91.224.253 (10 May 2004 07:56:41 GMT) X-Complaints-To: usenet@sea.gmane.org NNTP-Posting-Date: Mon, 10 May 2004 07:56:41 +0000 (UTC) Original-X-From: emacs-devel-bounces+emacs-devel=quimby.gnus.org@gnu.org Mon May 10 09:56:34 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 1BN5eM-0006qb-00 for ; Mon, 10 May 2004 09:56:34 +0200 Original-Received: from monty-python.gnu.org ([199.232.76.173]) by quimby.gnus.org with esmtp (Exim 3.35 #1 (Debian)) id 1BN5eM-0001fA-00 for ; Mon, 10 May 2004 09:56:34 +0200 Original-Received: from localhost ([127.0.0.1] helo=monty-python.gnu.org) by monty-python.gnu.org with esmtp (Exim 4.33) id 1BN5Nz-0003x2-6U for emacs-devel@quimby.gnus.org; Mon, 10 May 2004 03:39:39 -0400 Original-Received: from list by monty-python.gnu.org with tmda-scanned (Exim 4.33) id 1BN5Ni-0003vN-E4 for emacs-devel@gnu.org; Mon, 10 May 2004 03:39:22 -0400 Original-Received: from mail by monty-python.gnu.org with spam-scanned (Exim 4.33) id 1BN5NC-0003sB-JL for emacs-devel@gnu.org; Mon, 10 May 2004 03:39:21 -0400 Original-Received: from [62.22.181.117] (helo=idefix.laley.net) by monty-python.gnu.org with esmtp (Exim 4.33) id 1BN5M5-0003gv-W7 for emacs-devel@gnu.org; Mon, 10 May 2004 03:37:42 -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 JN3LM30B; Mon, 10 May 2004 09:36:51 +0200 Original-To: Stefan Monnier , 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:23024 X-Report-Spam: http://spam.gmane.org/gmane.emacs.devel:23024 On 09 May 2004 22:42:01 -0400 Stefan Monnier wrote: > I know, but you were saying that there is some resistance against adding > highlighting, and I think the resistance is more against colors. Yes, I agree. In this case, though, nobody's proposing to add color (except, perhaps, a shade of gray, which could be understood as changing intensity). > Well I find the highlighting attracts my eye to the arguments, but not to > the text that surrounds it, whereas I don't care so much about the argument > as I care about the text. > > Basically, my reaction is "Hmm... the argument OVERLAY is used three times > in the docstring; now, why should I care?". I think it boils down to personal differences. My though is more like "Ah, so OVERLAY is described here, here and... oh, here. Let's se what does it say about it." If we had very strict style requirements to writing docstrings, we could put marking on an argument's description, so we would be able to highlight (with whichever method is subtle enough) the doc's paragraph(s) were the argument is described and used. You could then type 1, 2, 3... on a *Help* buffer to switch highlighting between first, second, third argument, etc. But nowadays a docstring is just a bunch of text that satisfies a few loose guidelines: using args in uppercase, making the first line stand-alone for apropos, etc. As it stands, there's not easy way to show the Help information in a more useful make up. Juanma