From debbugs-submit-bounces@debbugs.gnu.org Mon Jan 08 10:39:28 2018 Received: (at submit) by debbugs.gnu.org; 8 Jan 2018 15:39:28 +0000 Received: from localhost ([127.0.0.1]:41436 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1eYZWK-00059W-4k for submit@debbugs.gnu.org; Mon, 08 Jan 2018 10:39:28 -0500 Received: from eggs.gnu.org ([208.118.235.92]:49112) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1eYZWJ-00059D-5D for submit@debbugs.gnu.org; Mon, 08 Jan 2018 10:39:27 -0500 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1eYZWC-0003xy-OP for submit@debbugs.gnu.org; Mon, 08 Jan 2018 10:39:21 -0500 X-Spam-Checker-Version: SpamAssassin 3.3.2 (2011-06-06) on eggs.gnu.org X-Spam-Level: X-Spam-Status: No, score=0.8 required=5.0 tests=BAYES_50,T_DKIM_INVALID autolearn=disabled version=3.3.2 Received: from lists.gnu.org ([2001:4830:134:3::11]:41752) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_256_CBC_SHA1:32) (Exim 4.71) (envelope-from ) id 1eYZWC-0003xo-Ke for submit@debbugs.gnu.org; Mon, 08 Jan 2018 10:39:20 -0500 Received: from eggs.gnu.org ([2001:4830:134:3::10]:40029) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1eYZWB-00084a-3x for bug-gnu-emacs@gnu.org; Mon, 08 Jan 2018 10:39:20 -0500 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1eYZW7-0003tl-6d for bug-gnu-emacs@gnu.org; Mon, 08 Jan 2018 10:39:19 -0500 Received: from mail.choca.pics ([62.210.108.126]:59120) by eggs.gnu.org with esmtps (TLS1.0:DHE_RSA_AES_256_CBC_SHA1:32) (Exim 4.71) (envelope-from ) id 1eYZW6-0003nK-TM; Mon, 08 Jan 2018 10:39:15 -0500 Received: from localhost (localhost.localdomain [IPv6:::1]) by mail.choca.pics (Postfix) with ESMTP id 7912F232FE91; Mon, 8 Jan 2018 16:39:06 +0100 (CET) Received: from mail.choca.pics ([IPv6:::1]) by localhost (mail.choca.pics [IPv6:::1]) (amavisd-new, port 10032) with ESMTP id DGs-BMUL_XeK; Mon, 8 Jan 2018 16:39:05 +0100 (CET) Received: from localhost (localhost.localdomain [IPv6:::1]) by mail.choca.pics (Postfix) with ESMTP id 6EF45232FE92; Mon, 8 Jan 2018 16:39:05 +0100 (CET) DKIM-Filter: OpenDKIM Filter v2.10.3 mail.choca.pics 6EF45232FE92 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=cassou.me; s=9EA44F5C-DEF4-11E6-A83F-A08DF322D8FB; t=1515425945; bh=VGcn2L1BZDeKbejn3Mjdr1J0Ap6UzyyIgIA+snPyZQ4=; h=From:To:Date:Message-ID:MIME-Version; b=Zef9fNzds5oCKVM0HA+rd5W4j9Z2Qkn11ySGJUyD3szLdYIgKQ95iyt+t8lLtW9A4 ADRu88iQcpU5q+Pg98on4mn0ox9PTKer2CeHznjtDP2SpVADWP6UaPuGRRchcqxRIP jfc128VQQ+WRG7Ux/P8Lq537EBvU2hQc0GtP+ZQcEFbpUhxvisHuOadUfEGfi2TxcP wKY7MqkrAKpfm2dtl80sHgfAS+TRxXF0VsazjqypeKhHShf9iJzDz5IyvFCjm82/Cm J2Gl08+nyaYeBn7gT8oFrKp1RQTJ7KgRIggcu4aDj36FqHQ/i4BkE2gKMy4d/DkOXh TinIdcORlMo+A== X-Virus-Scanned: amavisd-new at choca.pics Received: from mail.choca.pics ([IPv6:::1]) by localhost (mail.choca.pics [IPv6:::1]) (amavisd-new, port 10026) with ESMTP id YAk8K_GFvBf3; Mon, 8 Jan 2018 16:39:05 +0100 (CET) Received: from luz4 (20-44-190-109.dsl.ovh.fr [109.190.44.20]) by mail.choca.pics (Postfix) with ESMTPSA id 066F0232FE91; Mon, 8 Jan 2018 16:39:04 +0100 (CET) From: Damien Cassou To: bug-gnu-emacs@gnu.org Subject: 26.0.90; [Documentation][26.1] Docstring for epa-pinentry-mode shows erroneous link Date: Mon, 08 Jan 2018 16:39:01 +0100 Message-ID: <87r2r0e4x6.fsf@cassou.me> MIME-Version: 1.0 Content-Type: text/plain X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] [fuzzy] X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.6.x X-Received-From: 2001:4830:134:3::11 X-Spam-Score: -4.1 (----) X-Debbugs-Envelope-To: submit Cc: rms@gnu.org X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: -4.1 (----) How to reproduce: 1. C-h v epa-pinentry-mode RET Expected: the word "error" should be represented as a keyword, not as a link Actual: the word "error" is a link to the function of the same name. The docstring of epa-pinentry-mode describes 4 possible symbols for the value. These symbols only make sense in the context of the variable. In particular, they are not function or variable names. Still, the word error is represented as a link to the function of the same name. What is best practice to describe symbols in docstring? Best, -- Damien Cassou http://damiencassou.seasidehosting.st "Success is the ability to go from one failure to another without losing enthusiasm." --Winston Churchill From debbugs-submit-bounces@debbugs.gnu.org Mon Jan 08 16:29:10 2018 Received: (at 30025-done) by debbugs.gnu.org; 8 Jan 2018 21:29:10 +0000 Received: from localhost ([127.0.0.1]:41801 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1eYeyk-0008Tl-0L for submit@debbugs.gnu.org; Mon, 08 Jan 2018 16:29:10 -0500 Received: from eggs.gnu.org ([208.118.235.92]:49224) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1eYeyi-0008TY-C9 for 30025-done@debbugs.gnu.org; Mon, 08 Jan 2018 16:29:08 -0500 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1eYeyZ-0006w8-Qe for 30025-done@debbugs.gnu.org; Mon, 08 Jan 2018 16:29:02 -0500 X-Spam-Checker-Version: SpamAssassin 3.3.2 (2011-06-06) on eggs.gnu.org X-Spam-Level: X-Spam-Status: No, score=-0.0 required=5.0 tests=BAYES_20,T_RP_MATCHES_RCVD autolearn=disabled version=3.3.2 Received: from fencepost.gnu.org ([2001:4830:134:3::e]:43365) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1eYeyZ-0006w4-Mu; Mon, 08 Jan 2018 16:28:59 -0500 Received: from [176.228.60.248] (port=4125 helo=home-c4e4a596f7) by fencepost.gnu.org with esmtpsa (TLS1.2:RSA_AES_256_CBC_SHA1:256) (Exim 4.82) (envelope-from ) id 1eYeyS-0007mR-4n; Mon, 08 Jan 2018 16:28:52 -0500 Date: Mon, 08 Jan 2018 23:28:40 +0200 Message-Id: <83fu7g6nw7.fsf@gnu.org> From: Eli Zaretskii To: Damien Cassou In-reply-to: <87r2r0e4x6.fsf@cassou.me> (message from Damien Cassou on Mon, 08 Jan 2018 16:39:01 +0100) Subject: Re: bug#30025: 26.0.90; [Documentation][26.1] Docstring for epa-pinentry-mode shows erroneous link References: <87r2r0e4x6.fsf@cassou.me> X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] X-Received-From: 2001:4830:134:3::e X-Spam-Score: -5.0 (-----) X-Debbugs-Envelope-To: 30025-done Cc: 30025-done@debbugs.gnu.org, rms@gnu.org X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Reply-To: Eli Zaretskii Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: -5.0 (-----) > Date: Mon, 08 Jan 2018 16:39:01 +0100 > Cc: rms@gnu.org > > How to reproduce: > > 1. C-h v epa-pinentry-mode RET > > Expected: the word "error" should be represented as a keyword, not as a > link > > Actual: the word "error" is a link to the function of the same name. Thanks, fixed. > What is best practice to describe symbols in docstring? You need to use a magic word ;-) (It's all described in the node "Documentation Tips" of the ELisp manual.) From unknown Sat Aug 16 16:18:34 2025 Received: (at fakecontrol) by fakecontrolmessage; To: internal_control@debbugs.gnu.org From: Debbugs Internal Request Subject: Internal Control Message-Id: bug archived. Date: Tue, 06 Feb 2018 12:24:06 +0000 User-Agent: Fakemail v42.6.9 # This is a fake control message. # # The action: # bug archived. thanks # This fakemail brought to you by your local debbugs # administrator