From: Lars Ingebrigtsen <larsi@gnus.org>
To: Juri Linkov <juri@linkov.net>
Cc: Stefan Kangas <stefan@marxist.se>, 50390@debbugs.gnu.org
Subject: bug#50390: Improve documentation of 'read-char-choice-use-read-key' and 'y-or-n-p-use-read-key'
Date: Sun, 05 Sep 2021 12:03:28 +0200 [thread overview]
Message-ID: <87r1e3mj9r.fsf@gnus.org> (raw)
In-Reply-To: <87mtorv40i.fsf@mail.linkov.net> (Juri Linkov's message of "Sun, 05 Sep 2021 11:08:13 +0300")
Juri Linkov <juri@linkov.net> writes:
>> When I look into the documentation of those variables, I do not get
>> any explanation of why I would want to use them. I also can't find
>> any explanation in the manual.
>>
>> Even just one or two sentences that indicates its typical use would be
>> very helpful here.
>
> The problem is that read-char-choice still has no docstring.
> After adding it, the docstring of read-char-choice should
> refer to read-char-choice-use-read-key and explain it.
>
> y-or-n-p already has docstring and should mention y-or-n-p-use-read-key.
I've now added some text to the doc strings of the variables and
functions to try to explain what the difference here is, which isn't
obvious. Feel free to improve more -- it's kinda hard to succinctly
explain the user interface difference here.
--
(domestic pets only, the antidote for overdose, milk.)
bloggy blog: http://lars.ingebrigtsen.no
next prev parent reply other threads:[~2021-09-05 10:03 UTC|newest]
Thread overview: 6+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-09-05 2:56 bug#50390: Improve documentation of 'read-char-choice-use-read-key' and 'y-or-n-p-use-read-key' Stefan Kangas
2021-09-05 8:08 ` Juri Linkov
2021-09-05 10:03 ` Lars Ingebrigtsen [this message]
2021-09-05 10:11 ` Eli Zaretskii
2021-09-05 10:13 ` Lars Ingebrigtsen
2021-09-05 10:32 ` 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=87r1e3mj9r.fsf@gnus.org \
--to=larsi@gnus.org \
--cc=50390@debbugs.gnu.org \
--cc=juri@linkov.net \
--cc=stefan@marxist.se \
/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.