From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!.POSTED!not-for-mail From: Stefan Monnier Newsgroups: gmane.emacs.help Subject: Re: Referencing variables beginning with an asterisk in docstrings broken? Date: Sat, 27 Aug 2016 21:55:25 -0400 Message-ID: References: <87twe8gaqm.fsf@reisefreund.localdomain> NNTP-Posting-Host: blaine.gmane.org Mime-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit X-Trace: blaine.gmane.org 1472351108 12353 195.159.176.226 (28 Aug 2016 02:25:08 GMT) X-Complaints-To: usenet@blaine.gmane.org NNTP-Posting-Date: Sun, 28 Aug 2016 02:25:08 +0000 (UTC) User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/25.1.50 (gnu/linux) To: help-gnu-emacs@gnu.org Original-X-From: help-gnu-emacs-bounces+geh-help-gnu-emacs=m.gmane.org@gnu.org Sun Aug 28 04:25:05 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 1bdpmR-0002dw-Ok for geh-help-gnu-emacs@m.gmane.org; Sun, 28 Aug 2016 04:25:03 +0200 Original-Received: from localhost ([::1]:37907 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1bdpmP-0005ek-7J for geh-help-gnu-emacs@m.gmane.org; Sat, 27 Aug 2016 22:25:01 -0400 Original-Received: from eggs.gnu.org ([2001:4830:134:3::10]:42949) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1bdpK5-0008Mq-HH for help-gnu-emacs@gnu.org; Sat, 27 Aug 2016 21:55:46 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1bdpJz-0007pJ-Hp for help-gnu-emacs@gnu.org; Sat, 27 Aug 2016 21:55:44 -0400 Original-Received: from [195.159.176.226] (port=54216 helo=blaine.gmane.org) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1bdpJz-0007oq-5M for help-gnu-emacs@gnu.org; Sat, 27 Aug 2016 21:55:39 -0400 Original-Received: from list by blaine.gmane.org with local (Exim 4.84_2) (envelope-from ) id 1bdpJp-0000Hc-Vc for help-gnu-emacs@gnu.org; Sun, 28 Aug 2016 03:55:29 +0200 X-Injected-Via-Gmane: http://gmane.org/ Original-Lines: 11 Original-X-Complaints-To: usenet@blaine.gmane.org Cancel-Lock: sha1:Sk+2vUF2cGEKlSoLNv1Aef/NQvg= X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] X-Received-From: 195.159.176.226 X-Mailman-Approved-At: Sat, 27 Aug 2016 22:24:25 -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:111216 Archived-At: > I’d 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? Probably a bug, but do note that Elisp is not Common-Lisp, so I strongly recommend you follow the Elisp convention of using a "-" prefix instead of using asterisks for global variables. Stefan