From mboxrd@z Thu Jan 1 00:00:00 1970 Path: main.gmane.org!not-for-mail From: Miles Bader Newsgroups: gmane.emacs.devel Subject: Re: new *Help* argument highlighting Date: 12 May 2004 18:25:37 +0900 Sender: emacs-devel-bounces+emacs-devel=quimby.gnus.org@gnu.org Message-ID: References: <20040512103042.FB57.JMBARRANQUERO@wke.es> Reply-To: Miles Bader NNTP-Posting-Host: deer.gmane.org Mime-Version: 1.0 Content-Type: text/plain; charset=us-ascii X-Trace: sea.gmane.org 1084354154 1263 80.91.224.253 (12 May 2004 09:29:14 GMT) X-Complaints-To: usenet@sea.gmane.org NNTP-Posting-Date: Wed, 12 May 2004 09:29:14 +0000 (UTC) Cc: emacs-devel@gnu.org Original-X-From: emacs-devel-bounces+emacs-devel=quimby.gnus.org@gnu.org Wed May 12 11:29:07 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 1BNq31-0003VX-00 for ; Wed, 12 May 2004 11:29:07 +0200 Original-Received: from monty-python.gnu.org ([199.232.76.173]) by quimby.gnus.org with esmtp (Exim 3.35 #1 (Debian)) id 1BNq31-0002ZG-00 for ; Wed, 12 May 2004 11:29:07 +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 1BNq1D-00024f-Pb for emacs-devel@quimby.gnus.org; Wed, 12 May 2004 05:27:15 -0400 Original-Received: from list by monty-python.gnu.org with tmda-scanned (Exim 4.34) id 1BNq0z-00023D-4I for emacs-devel@gnu.org; Wed, 12 May 2004 05:27:01 -0400 Original-Received: from mail by monty-python.gnu.org with spam-scanned (Exim 4.34) id 1BNq0S-0001ty-PG for emacs-devel@gnu.org; Wed, 12 May 2004 05:26:59 -0400 Original-Received: from [202.32.8.202] (helo=TYO202.gate.nec.co.jp) by monty-python.gnu.org with esmtp (Exim 4.34) id 1BNpzv-0001lU-4Z; Wed, 12 May 2004 05:25:55 -0400 Original-Received: from mailgate3.nec.co.jp (mailgate53.nec.co.jp [10.7.69.160] (may be forged)) by TYO202.gate.nec.co.jp (8.11.7/3.7W01080315) with ESMTP id i4C9PfY06502; Wed, 12 May 2004 18:25:41 +0900 (JST) Original-Received: (from root@localhost) by mailgate3.nec.co.jp (8.11.7/3.7W-MAILGATE-NEC) id i4C9PfW08208; Wed, 12 May 2004 18:25:41 +0900 (JST) Original-Received: from edtmg01.lsi.nec.co.jp ([10.26.16.201]) by mailsv.nec.co.jp (8.11.7/3.7W-MAILSV-NEC) with ESMTP id i4C9Pe321770; Wed, 12 May 2004 18:25:40 +0900 (JST) Original-Received: from mcsss2.ucom.lsi.nec.co.jp (localhost [127.0.0.1]) by edtmg01.lsi.nec.co.jp (8.12.10/8.12.10) with ESMTP id i4C9Pct7020110; Wed, 12 May 2004 18:25:39 +0900 (JST) Original-Received: from mcspd15 (mcspd15 [10.30.114.174]) by mcsss2.ucom.lsi.nec.co.jp (8.12.10/8.12.8/EDcg v2.01-mc/1046780839) with ESMTP id i4C9PcaQ013969; Wed, 12 May 2004 18:25:38 +0900 (JST) Original-Received: by mcspd15 (Postfix, from userid 31295) id C1C90411; Wed, 12 May 2004 18:25:37 +0900 (JST) Original-To: Juanma Barranquero System-Type: i686-pc-linux-gnu Blat: Foop In-Reply-To: <20040512103042.FB57.JMBARRANQUERO@wke.es> Original-Lines: 19 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:23227 X-Report-Spam: http://spam.gmane.org/gmane.emacs.devel:23227 Juanma Barranquero writes: > > Why not use the texinfo convention, @var{name} ? > > I was thinking of something similar to substitute-command-keys markers, > i.e., "\<>", "\{}" and "\[]" Prob with that kind of thing is that there's a very limited number of them, and the closer you get to running out, the weirder and more obscure they get... :-) It's a little tricky, since docstrings also serve as documentation in the source file they occur in, so you don't want notation that's _too_ verbose, but personally I think @var is reasonable enough, and docstrings are much more often viewed in *Help*. -Miles -- o The existentialist, not having a pillow, goes everywhere with the book by Sullivan, _I am going to spit on your graves_.