[debbugs-tracker] bug#30025: closed (26.0.90; [Documentation][26.1] Docstring for epa-pinentry-mode shows erroneous link)

[GNU bug Tracking System]

Your message dated Mon, 08 Jan 2018 23:28:40 +0200
with message-id <address@hidden>
and subject line Re: bug#30025: 26.0.90; [Documentation][26.1] Docstring for 
epa-pinentry-mode shows erroneous link
has caused the debbugs.gnu.org bug report #30025,
regarding 26.0.90; [Documentation][26.1] Docstring for epa-pinentry-mode shows 
erroneous link
to be marked as done.

(If you believe you have received this mail in error, please contact
address@hidden)


-- 
30025: http://debbugs.gnu.org/cgi/bugreport.cgi?bug=30025
GNU Bug Tracking System
Contact address@hidden with problems
> --- Begin Message ---
>
>
>
> Subject: 
>
> 26.0.90; [Documentation][26.1] Docstring for epa-pinentry-mode shows erroneous link
>
>
>
>
> Date: 
>
> Mon, 08 Jan 2018 16:39:01 +0100
>
>
>
>
> 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
>
>
>
> --- End Message ---
> --- Begin Message ---
>
>
>
> 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: address@hidden
> > 
> > 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.)
>
>
> --- End Message ---