From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!not-for-mail From: "Drew Adams" Newsgroups: gmane.emacs.devel Subject: RE: Why are ` and ' shown in help for doc strings? Date: Fri, 15 Dec 2006 17:17:21 -0800 Message-ID: References: <45834635.8010801@student.lu.se> NNTP-Posting-Host: dough.gmane.org Mime-Version: 1.0 Content-Type: text/plain; charset="iso-8859-1" Content-Transfer-Encoding: 7bit X-Trace: sea.gmane.org 1166232490 7234 80.91.229.10 (16 Dec 2006 01:28:10 GMT) X-Complaints-To: usenet@sea.gmane.org NNTP-Posting-Date: Sat, 16 Dec 2006 01:28:10 +0000 (UTC) Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Sat Dec 16 02:28:08 2006 Return-path: Envelope-to: ged-emacs-devel@m.gmane.org Original-Received: from lists.gnu.org ([199.232.76.165]) by dough.gmane.org with esmtp (Exim 4.50) id 1GvOLP-0003gz-HH for ged-emacs-devel@m.gmane.org; Sat, 16 Dec 2006 02:28:08 +0100 Original-Received: from localhost ([127.0.0.1] helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.43) id 1GvOLN-0007CY-Tw for ged-emacs-devel@m.gmane.org; Fri, 15 Dec 2006 20:28:05 -0500 Original-Received: from mailman by lists.gnu.org with tmda-scanned (Exim 4.43) id 1GvOLD-0007CD-4E for emacs-devel@gnu.org; Fri, 15 Dec 2006 20:27:55 -0500 Original-Received: from exim by lists.gnu.org with spam-scanned (Exim 4.43) id 1GvOL7-0007B4-VS for emacs-devel@gnu.org; Fri, 15 Dec 2006 20:27:54 -0500 Original-Received: from [199.232.76.173] (helo=monty-python.gnu.org) by lists.gnu.org with esmtp (Exim 4.43) id 1GvOL7-0007B1-PC for emacs-devel@gnu.org; Fri, 15 Dec 2006 20:27:49 -0500 Original-Received: from [148.87.113.118] (helo=rgminet01.oracle.com) by monty-python.gnu.org with esmtps (TLS-1.0:DHE_RSA_AES_256_CBC_SHA:32) (Exim 4.52) id 1GvOL5-0001Vx-Vg for emacs-devel@gnu.org; Fri, 15 Dec 2006 20:27:48 -0500 Original-Received: from rgmgw3.us.oracle.com (rgmgw3.us.oracle.com [138.1.186.112]) by rgminet01.oracle.com (Switch-3.2.4/Switch-3.1.6) with ESMTP id kBG1RZJh022476 for ; Fri, 15 Dec 2006 18:27:35 -0700 Original-Received: from rcsmt250.oracle.com (rcsmt250.oracle.com [148.87.90.195]) by rgmgw3.us.oracle.com (Switch-3.2.4/Switch-3.1.7) with ESMTP id kBG1RVQf022730 for ; Fri, 15 Dec 2006 18:27:31 -0700 Original-Received: from dhcp-amer-csvpn-gw2-141-144-74-120.vpn.oracle.com by rcsmt250.oracle.com with ESMTP id 2298217581166231844; Fri, 15 Dec 2006 18:17:24 -0700 Original-To: "Emacs Devel" X-Priority: 3 (Normal) X-MSMail-Priority: Normal X-Mailer: Microsoft Outlook IMO, Build 9.0.6604 (9.0.2911.0) In-Reply-To: <45834635.8010801@student.lu.se> Importance: Normal X-MimeOLE: Produced By Microsoft MimeOLE V6.00.2900.2962 X-Brightmail-Tracker: AAAAAQAAAAI= X-Brightmail-Tracker: AAAAAQAAAAI= X-Whitelist: TRUE X-Whitelist: TRUE X-BeenThere: emacs-devel@gnu.org X-Mailman-Version: 2.1.5 Precedence: list List-Id: "Emacs development discussions." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Original-Sender: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Errors-To: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Xref: news.gmane.org gmane.emacs.devel:63816 Archived-At: > If you write something like `some-var' it will show up just like that in > the doc string, but with some-var underlined. The underlining makes > some-var stick out pretty well. Why are ` and ' still shown then? Please don't change this (I know you didn't actually suggest that). One reason might be that it isn't always underlined; I don't know. My reasons: 1. Doc strings can be used in different places (e.g. by 3rd-party libraries), not all of which would show this as underlined (a link). 2. This is a conventional notation, and as such is consistent with other references to variables and other names in the manuals. 3. 3rd-party code might use `...' to highlight names specially (I do that in Info, for instance). I think, but others will correct me, that the underlining is specific to the help context, where the name happens to be a hyperlink, whereas the `...' is a doc convention for names everywhere (and `...' is perhaps rendered differently in printed doc).