From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!.POSTED!not-for-mail From: Nathanael Schweers Newsgroups: gmane.emacs.help Subject: Referencing variables beginning with an asterisk in docstrings broken? Date: Thu, 25 Aug 2016 16:54:25 +0200 Message-ID: <87twe8gaqm.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 1472154791 21454 195.159.176.226 (25 Aug 2016 19:53:11 GMT) X-Complaints-To: usenet@blaine.gmane.org NNTP-Posting-Date: Thu, 25 Aug 2016 19:53:11 +0000 (UTC) To: help-gnu-emacs@gnu.org Original-X-From: help-gnu-emacs-bounces+geh-help-gnu-emacs=m.gmane.org@gnu.org Thu Aug 25 21:53:07 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 1bd0i2-0005Ko-TQ for geh-help-gnu-emacs@m.gmane.org; Thu, 25 Aug 2016 21:53:07 +0200 Original-Received: from localhost ([::1]:57871 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1bd0i0-0001Uy-DD for geh-help-gnu-emacs@m.gmane.org; Thu, 25 Aug 2016 15:53:04 -0400 Original-Received: from eggs.gnu.org ([2001:4830:134:3::10]:37478) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1bcw39-0002Re-HE for help-gnu-emacs@gnu.org; Thu, 25 Aug 2016 10:54:36 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1bcw33-0007GY-Lo for help-gnu-emacs@gnu.org; Thu, 25 Aug 2016 10:54:34 -0400 Original-Received: from mx1.mailbox.org ([80.241.60.212]:42354) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1bcw33-0007GM-BY for help-gnu-emacs@gnu.org; Thu, 25 Aug 2016 10:54:29 -0400 Original-Received: from smtp1.mailbox.org (smtp1.mailbox.org [80.241.60.240]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mx1.mailbox.org (Postfix) with ESMTPS id E99FA443A5 for ; Thu, 25 Aug 2016 16:54:27 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=mailbox.org; h= content-transfer-encoding:content-type:content-type:mime-version :message-id:date:date:subject:subject:from:from:received; s= mail20150812; t=1472136867; bh=sw6QzXkj+5fZhJZ0wUjM1aXfDaoMZ5e0R QtvdUp3sm4=; b=QY4zG5OROJY4dlynNoJO6eklHuI3sWW73gtINKaXOpE3gIwwY Mu3BTFD6X5ngYxOCjftjYvcn544hLO1CEQJkOoBo8aeo3rfnRex1TiXqcD19OCw9 Cn8U288TqxrjXS3ZbXEhwjhaQFs1AlFSWmQOyCvLXF5ToNLIK9rLQG9vnbSrpDeS HFrLjUj3AKg4e876DdYxYJRZR3LyPwJ0ki0iTae8mvb+VKktB+9rjlzcM3/vQEF/ 4O+FLg8pzTpnZ6rOMhPkE6J0/tlRIBelZsmxBUOHVGNGdntNs+vCMi3rKEOzTRHi XNf4IQfCQOwIffKwC690Kbu6zDoLhnLr4++ug== X-Virus-Scanned: amavisd-new at heinlein-support.de Original-Received: from smtp1.mailbox.org ([80.241.60.240]) by hefe.heinlein-support.de (hefe.heinlein-support.de [91.198.250.172]) (amavisd-new, port 10030) with ESMTP id pMrXdlDsyr1r for ; Thu, 25 Aug 2016 16:54:27 +0200 (CEST) X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] X-Received-From: 80.241.60.212 X-Mailman-Approved-At: Thu, 25 Aug 2016 15:52:17 -0400 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:111195 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 T= ips=E2=80=9D one merely has to reference the variable in question between the quotation marks =E2=80=98 and =E2=80=99. 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 does = =E2=80=98varname*=E2=80=99, yet not =E2=80=98*varname=E2=80=99. Hence, =E2=80=98*varname*=E2=80=99 als= o does not work. I=E2=80=99d like to adhere to the Common Lisp convention of naming special variables in my elisp code, yet if I do so, I cannot seem to reference them in docstrings. Is this behaviour a bug? Best Regards, Nathanael Schweers --=20