all messages for Emacs-related lists mirrored at yhetil.org
 help / color / mirror / code / Atom feed
From: Damien Cassou <damien@cassou.me>
To: 30025@debbugs.gnu.org
Cc: rms@gnu.org
Subject: bug#30025: 26.0.90; [Documentation][26.1] Docstring for epa-pinentry-mode shows erroneous link
Date: Mon, 08 Jan 2018 16:39:01 +0100	[thread overview]
Message-ID: <87r2r0e4x6.fsf@cassou.me> (raw)

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





             reply	other threads:[~2018-01-08 15:39 UTC|newest]

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2018-01-08 15:39 Damien Cassou [this message]
2018-01-08 21:28 ` bug#30025: 26.0.90; [Documentation][26.1] Docstring for epa-pinentry-mode shows erroneous link Eli Zaretskii

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=87r2r0e4x6.fsf@cassou.me \
    --to=damien@cassou.me \
    --cc=30025@debbugs.gnu.org \
    --cc=rms@gnu.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
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.