GNU bug report logs - #30025
26.0.90; [Documentation][26.1] Docstring for epa-pinentry-mode shows erroneous link

Previous Next

Package: emacs;

Reported by: Damien Cassou <damien <at> cassou.me>

Date: Mon, 8 Jan 2018 15:40:02 UTC

Severity: minor

Found in version 26.0.90

Done: Eli Zaretskii <eliz <at> gnu.org>

Bug is archived. No further changes may be made.

Full log

Message #10 received at 30025-done <at> debbugs.gnu.org (full text, mbox):

From: Eli Zaretskii <eliz <at> gnu.org>
To: Damien Cassou <damien <at> cassou.me>
Cc: 30025-done <at> debbugs.gnu.org, rms <at> gnu.org
Subject: Re: bug#30025: 26.0.90;
 [Documentation][26.1] Docstring for epa-pinentry-mode shows erroneous
 link
Date: Mon, 08 Jan 2018 23:28:40 +0200

> Date: Mon, 08 Jan 2018 16:39:01 +0100
> Cc: rms <at> 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.)
This bug report was last modified 7 years and 193 days ago.

Previous Next

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.