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 02:53:11 +0200 Sender: emacs-devel-bounces+emacs-devel=quimby.gnus.org@gnu.org Message-ID: <20040510023212.F99D.LEKTU@mi.madritel.es> References: <20040510020140.F99A.LEKTU@mi.madritel.es> NNTP-Posting-Host: deer.gmane.org Mime-Version: 1.0 Content-Type: text/plain; charset="ISO-8859-1" Content-Transfer-Encoding: quoted-printable X-Trace: sea.gmane.org 1084150471 3344 80.91.224.253 (10 May 2004 00:54:31 GMT) X-Complaints-To: usenet@sea.gmane.org NNTP-Posting-Date: Mon, 10 May 2004 00:54:31 +0000 (UTC) Original-X-From: emacs-devel-bounces+emacs-devel=quimby.gnus.org@gnu.org Mon May 10 02:54:22 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 1BMz3m-00030K-00 for ; Mon, 10 May 2004 02:54:22 +0200 Original-Received: from monty-python.gnu.org ([199.232.76.173]) by quimby.gnus.org with esmtp (Exim 3.35 #1 (Debian)) id 1BMz3m-00011Z-00 for ; Mon, 10 May 2004 02:54:22 +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 1BMz3j-0001ZM-C3 for emacs-devel@quimby.gnus.org; Sun, 09 May 2004 20:54:19 -0400 Original-Received: from list by monty-python.gnu.org with tmda-scanned (Exim 4.33) id 1BMz3I-0001Pv-DN for emacs-devel@gnu.org; Sun, 09 May 2004 20:53:52 -0400 Original-Received: from mail by monty-python.gnu.org with spam-scanned (Exim 4.33) id 1BMz2i-0001Mq-Tc for emacs-devel@gnu.org; Sun, 09 May 2004 20:53:51 -0400 Original-Received: from [62.81.186.19] (helo=smtp09.retemail.es) by monty-python.gnu.org with esmtp (Exim 4.33) id 1BMz2g-0001LR-Dj for emacs-devel@gnu.org; Sun, 09 May 2004 20:53:15 -0400 Original-Received: from [127.0.0.1] ([213.37.34.31]) by smtp09.retemail.es (InterMail vM.5.01.05.32 201-253-122-126-132-20030307) with ESMTP id <20040510005312.CFPB25645.smtp09.retemail.es@[127.0.0.1]>; Mon, 10 May 2004 02:53:12 +0200 Original-To: Stefan Monnier , emacs-devel@gnu.org In-Reply-To: X-Mailer: Becky! ver. 2.09.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:23010 X-Report-Spam: http://spam.gmane.org/gmane.emacs.devel:23010 On 09 May 2004 20:25:13 -0400, Stefan Monnier wr= ote: > I think you're wrong. There's a lot of problems with adding colors. Sure. But we already have lots of faces, some of which add colors with not much remorse: (defface comint-highlight-prompt '((((background dark)) (:foreground "cyan")) (t (:foreground "dark blue"))) "Face to use to highlight prompts." :group 'comint) (defface hi-yellow '((((background dark)) (:background "yellow" :foreground "black")) (t (:background "yellow"))) "Default face for hi-lock mode." :group 'hi-lock-faces) (defface smerge-mine-face '((((background light)) (:foreground "blue")) (((background dark)) (:foreground "cyan"))) "Face for your code." :group 'smerge) (defface speedbar-button-face '((((class color) (background light)) (:foreground "green4")) (((class color) (background dark)) (:foreground "green3"))) "Face used for +/- buttons." :group 'speedbar-faces) That said, I wouldn't advocate adding colors to this as a default. > But playing with font size is pretty safe (at least, I can't remember > a single complaint from the font-size change in Info-mode, for example). As I said, it's OK to me if that's what's decided. > As said, it's not the fact of highlighting that surprises, it's just the > fact that args and only args are highlighted as if they were so > very special. Aren't? In an elisp function's help, I honestly don't know what else could be special... Perhaps if we had a more structured style guide for function docstrings, with sections =E0 la: MYFUNCTION is a function in .emacs.el. # where/bindings It is bound to H-z. (myfunction A B &optional C) # function header MYFUNCTION is an obsolete function # obsolescence info since the beginning of time; do not use it. The object of MYFUNCTION is serving as an example. # function description You can use it at your leisure. Argument A is for whatever you want. # argument usage B, on the other hand, is unused. Optional C defaults to nil, and should stay so. Example: # example (myfunction 7 "I'm being ignored") Notes: # additional notes You really shouldn't use this function. It hasn't been tested on the wild so it could misfire. then I'd understand why highlighting just arguments would be weird. > Note that I try to consistently say "surprise" rather than > "bother". I'm not opposed to it, but I think it currently looks odd. Yeah, I understand. Let's see whether we can agree on something generally useful and non-surprising/non-bothering.=20 Thanks, /L/e/k/t/u