From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!.POSTED!not-for-mail From: Drew Adams Newsgroups: gmane.emacs.help Subject: RE: Referencing variables beginning with an asterisk in docstrings broken? Date: Thu, 25 Aug 2016 13:19:57 -0700 (PDT) Message-ID: References: <871t1dgdff.fsf@reisefreund.localdomain> NNTP-Posting-Host: blaine.gmane.org Mime-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: quoted-printable X-Trace: blaine.gmane.org 1472156452 19717 195.159.176.226 (25 Aug 2016 20:20:52 GMT) X-Complaints-To: usenet@blaine.gmane.org NNTP-Posting-Date: Thu, 25 Aug 2016 20:20:52 +0000 (UTC) To: Nathanael Schweers , help-gnu-emacs@gnu.org Original-X-From: help-gnu-emacs-bounces+geh-help-gnu-emacs=m.gmane.org@gnu.org Thu Aug 25 22:20:48 2016 Return-path: Envelope-to: geh-help-gnu-emacs@m.gmane.org Original-Received: from lists.gnu.org ([208.118.235.17]) by blaine.gmane.org with esmtp (Exim 4.84_2) (envelope-from ) id 1bd18q-0004sU-8o for geh-help-gnu-emacs@m.gmane.org; Thu, 25 Aug 2016 22:20:48 +0200 Original-Received: from localhost ([::1]:57945 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1bd18n-00030c-IN for geh-help-gnu-emacs@m.gmane.org; Thu, 25 Aug 2016 16:20:45 -0400 Original-Received: from eggs.gnu.org ([2001:4830:134:3::10]:55010) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1bd18F-000302-3d for help-gnu-emacs@gnu.org; Thu, 25 Aug 2016 16:20:11 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1bd18B-0003Br-Tv for help-gnu-emacs@gnu.org; Thu, 25 Aug 2016 16:20:11 -0400 Original-Received: from userp1040.oracle.com ([156.151.31.81]:31181) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1bd18B-0003AF-KM for help-gnu-emacs@gnu.org; Thu, 25 Aug 2016 16:20:07 -0400 Original-Received: from aserv0022.oracle.com (aserv0022.oracle.com [141.146.126.234]) by userp1040.oracle.com (Sentrion-MTA-4.3.2/Sentrion-MTA-4.3.2) with ESMTP id u7PKK3Ru016938 (version=TLSv1.2 cipher=ECDHE-RSA-AES256-GCM-SHA384 bits=256 verify=OK); Thu, 25 Aug 2016 20:20:04 GMT Original-Received: from userv0122.oracle.com (userv0122.oracle.com [156.151.31.75]) by aserv0022.oracle.com (8.14.4/8.14.4) with ESMTP id u7PKK27H019734 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-GCM-SHA384 bits=256 verify=OK); Thu, 25 Aug 2016 20:20:03 GMT Original-Received: from abhmp0008.oracle.com (abhmp0008.oracle.com [141.146.116.14]) by userv0122.oracle.com (8.14.4/8.14.4) with ESMTP id u7PKJwtn024480; Thu, 25 Aug 2016 20:20:02 GMT In-Reply-To: <871t1dgdff.fsf@reisefreund.localdomain> X-Priority: 3 X-Mailer: Oracle Beehive Extensions for Outlook 2.0.1.9 (901082) [OL 12.0.6753.5000 (x86)] X-Source-IP: aserv0022.oracle.com [141.146.126.234] X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.4.x-2.6.x [generic] X-Received-From: 156.151.31.81 X-BeenThere: help-gnu-emacs@gnu.org X-Mailman-Version: 2.1.21 Precedence: list List-Id: Users list for the GNU Emacs text editor List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: help-gnu-emacs-bounces+geh-help-gnu-emacs=m.gmane.org@gnu.org Original-Sender: "help-gnu-emacs" Xref: news.gmane.org gmane.emacs.help:111197 Archived-At: > I wanted to include a reference to a global (dynamic) variable in one of > my docstrings. According to the info page =E2=80=9C(elisp) Documentation= Tips=E2=80=9D > one merely has to reference the variable in question between the > quotation marks =E2=80=98 and =E2=80=99. >=20 > As far as I can tell so far, this works, as long as the variable does > not start with an asterisk. I.e. =E2=80=98varname=E2=80=99 works, so doe= s =E2=80=98varname*=E2=80=99, > yet not =E2=80=98*varname=E2=80=99. Hence, =E2=80=98*varname*=E2=80=99 a= lso does not work. >=20 > I=E2=80=99d like to adhere to the Common Lisp convention of naming specia= l > variables in my elisp code, yet if I do so, I cannot seem to reference > them in docstrings. >=20 > Is this behaviour a bug? Sure sounds like a bug to me.