all messages for Emacs-related lists mirrored at yhetil.org
 help / color / mirror / code / Atom feed
* bug#30025: 26.0.90; [Documentation][26.1] Docstring for epa-pinentry-mode shows erroneous link
@ 2018-01-08 15:39 Damien Cassou
  2018-01-08 21:28 ` Eli Zaretskii
  0 siblings, 1 reply; 2+ messages in thread
From: Damien Cassou @ 2018-01-08 15:39 UTC (permalink / raw)
  To: 30025; +Cc: rms

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





^ permalink raw reply	[flat|nested] 2+ messages in thread

end of thread, other threads:[~2018-01-08 21:28 UTC | newest]

Thread overview: 2+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2018-01-08 15:39 bug#30025: 26.0.90; [Documentation][26.1] Docstring for epa-pinentry-mode shows erroneous link Damien Cassou
2018-01-08 21:28 ` Eli Zaretskii

Code repositories for project(s) associated with this external index

	https://git.savannah.gnu.org/cgit/emacs.git
	https://git.savannah.gnu.org/cgit/emacs/org-mode.git

This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.