Subject: Re: bug#30025: 26.0.90; [Documentation][26.1] Docstring for epa-pinentry-mode shows erroneous link
From: Eli Zaretskii <[email-masked]>
To: Damien Cassou <[email-masked]>
Cc: [email-masked], [email-masked]
Date: Mon, 08 Jan 2018 23:28:40 +0200
List-Id: <debbugs-submit.debbugs.gnu.org>

> Date: Mon, 08 Jan 2018 16:39:01 +0100
> Cc: [email-masked]
> 
> 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.)