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: Re: Referencing variables beginning with an asterisk in docstrings broken? Date: Mon, 29 Aug 2016 01:32:41 +0200 Message-ID: <87shtoeag6.fsf@reisefreund.localdomain> 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: quoted-printable X-Trace: blaine.gmane.org 1472427211 3351 195.159.176.226 (28 Aug 2016 23:33:31 GMT) X-Complaints-To: usenet@blaine.gmane.org NNTP-Posting-Date: Sun, 28 Aug 2016 23:33:31 +0000 (UTC) Cc: help-gnu-emacs@gnu.org To: Stefan Monnier Original-X-From: help-gnu-emacs-bounces+geh-help-gnu-emacs=m.gmane.org@gnu.org Mon Aug 29 01:33:27 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 1be9Zt-0000P4-1k for geh-help-gnu-emacs@m.gmane.org; Mon, 29 Aug 2016 01:33:25 +0200 Original-Received: from localhost ([::1]:41219 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1be9Zq-0001dS-Mb for geh-help-gnu-emacs@m.gmane.org; Sun, 28 Aug 2016 19:33:22 -0400 Original-Received: from eggs.gnu.org ([2001:4830:134:3::10]:60494) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1be9ZO-0001bb-Gv for help-gnu-emacs@gnu.org; Sun, 28 Aug 2016 19:32:55 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1be9ZJ-0006dY-Gh for help-gnu-emacs@gnu.org; Sun, 28 Aug 2016 19:32:53 -0400 Original-Received: from mx2.mailbox.org ([80.241.60.215]:58282) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1be9ZJ-0006dN-6H for help-gnu-emacs@gnu.org; Sun, 28 Aug 2016 19:32:49 -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 mx2.mailbox.org (Postfix) with ESMTPS id E6519436A7; Mon, 29 Aug 2016 01:32:46 +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:in-reply-to:date:date:references:subject:subject :from:from:received; s=mail20150812; t=1472427162; bh=Xm8AX4/kdK gNmIWyLVMqo6asf4jjbrmr6mx6cAVvqUM=; b=sMzqdnxp0q1jONAw2iHI5QxjQD VdvoQbQhZrW2Bizqef6OS3WeZ89kAzZg7Nsma5/VCEz3LPKGoxRj/5PW6efC4dUO 4IyCFcKsyCkrT506a0GfbJs+AMyVaJLU8BpOTbhn/nCUlSjwevsuXTn22cFcmoSK 2X4mtPsa0gbkSv+Z+Szhg1d/IJkPDaBK8kXCyJj4A7Ub/QHkDYZMYwvUC13DeFPU mGVY27YBKUMtbgDQHE5IH5sSqTFXV/sSg3DathsIL7vIS/+8CjMQzglWDetmlgEo jR1sH7TgojjSReeLKBw9teltNc0BBFOoFzA/z/JnQJzU9aQ0ao4c6n0J3rbg== 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 F6V3AYLAG98x; Mon, 29 Aug 2016 01:32:42 +0200 (CEST) In-Reply-To: (Stefan Monnier's message of "Sat, 27 Aug 2016 21:55:25 -0400") X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] X-Received-From: 80.241.60.215 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:111222 Archived-At: Stefan Monnier writes: >> I=E2=80=99d like to adhere to the Common Lisp convention of naming speci= al >> 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 > > I did both. I also filed a bug, but it seems that this is because of some heuristic to prevent too many false positives. I guess I=E2=80=99ll e= ither change my naming, or just live with it. Currently I use *prefix/public-var*, but I guess prefix/*public-var* might be even better. Nathanael --=20