* bug#50390: Improve documentation of 'read-char-choice-use-read-key' and 'y-or-n-p-use-read-key'
@ 2021-09-05 2:56 Stefan Kangas
2021-09-05 8:08 ` Juri Linkov
0 siblings, 1 reply; 6+ messages in thread
From: Stefan Kangas @ 2021-09-05 2:56 UTC (permalink / raw)
To: 50390; +Cc: juri linkov
Severity: wishlist
X-Debbugs-CC: Juri Linkov <juri@linkov.net>
I read in NEWS for Emacs 28:
New variables 'read-char-choice-use-read-key' and 'y-or-n-p-use-read-key'.
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.
^ permalink raw reply [flat|nested] 6+ messages in thread* bug#50390: Improve documentation of 'read-char-choice-use-read-key' and 'y-or-n-p-use-read-key'
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
0 siblings, 1 reply; 6+ messages in thread
From: Juri Linkov @ 2021-09-05 8:08 UTC (permalink / raw)
To: Stefan Kangas; +Cc: 50390
> I read in NEWS for Emacs 28:
>
> New variables 'read-char-choice-use-read-key' and 'y-or-n-p-use-read-key'.
>
> 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.
^ permalink raw reply [flat|nested] 6+ messages in thread
* bug#50390: Improve documentation of 'read-char-choice-use-read-key' and 'y-or-n-p-use-read-key'
2021-09-05 8:08 ` Juri Linkov
@ 2021-09-05 10:03 ` Lars Ingebrigtsen
2021-09-05 10:11 ` Eli Zaretskii
0 siblings, 1 reply; 6+ messages in thread
From: Lars Ingebrigtsen @ 2021-09-05 10:03 UTC (permalink / raw)
To: Juri Linkov; +Cc: Stefan Kangas, 50390
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
^ permalink raw reply [flat|nested] 6+ messages in thread
* bug#50390: Improve documentation of 'read-char-choice-use-read-key' and 'y-or-n-p-use-read-key'
2021-09-05 10:03 ` Lars Ingebrigtsen
@ 2021-09-05 10:11 ` Eli Zaretskii
2021-09-05 10:13 ` Lars Ingebrigtsen
0 siblings, 1 reply; 6+ messages in thread
From: Eli Zaretskii @ 2021-09-05 10:11 UTC (permalink / raw)
To: Lars Ingebrigtsen; +Cc: stefan, 50390, juri
> From: Lars Ingebrigtsen <larsi@gnus.org>
> Date: Sun, 05 Sep 2021 12:03:28 +0200
> Cc: Stefan Kangas <stefan@marxist.se>, 50390@debbugs.gnu.org
>
> 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.
What is the non-succinct explanation?
^ permalink raw reply [flat|nested] 6+ messages in thread
* bug#50390: Improve documentation of 'read-char-choice-use-read-key' and 'y-or-n-p-use-read-key'
2021-09-05 10:11 ` Eli Zaretskii
@ 2021-09-05 10:13 ` Lars Ingebrigtsen
2021-09-05 10:32 ` Eli Zaretskii
0 siblings, 1 reply; 6+ messages in thread
From: Lars Ingebrigtsen @ 2021-09-05 10:13 UTC (permalink / raw)
To: Eli Zaretskii; +Cc: stefan, 50390, juri
Eli Zaretskii <eliz@gnu.org> writes:
>> 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.
>
> What is the non-succinct explanation?
It's in the patch. :-)
--
(domestic pets only, the antidote for overdose, milk.)
bloggy blog: http://lars.ingebrigtsen.no
^ permalink raw reply [flat|nested] 6+ messages in thread
* bug#50390: Improve documentation of 'read-char-choice-use-read-key' and 'y-or-n-p-use-read-key'
2021-09-05 10:13 ` Lars Ingebrigtsen
@ 2021-09-05 10:32 ` Eli Zaretskii
0 siblings, 0 replies; 6+ messages in thread
From: Eli Zaretskii @ 2021-09-05 10:32 UTC (permalink / raw)
To: Lars Ingebrigtsen; +Cc: stefan, 50390, juri
> From: Lars Ingebrigtsen <larsi@gnus.org>
> Cc: stefan@marxist.se, 50390@debbugs.gnu.org, juri@linkov.net
> Date: Sun, 05 Sep 2021 12:13:23 +0200
>
> Eli Zaretskii <eliz@gnu.org> writes:
>
> >> 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.
> >
> > What is the non-succinct explanation?
>
> It's in the patch. :-)
LGTM.
^ permalink raw reply [flat|nested] 6+ messages in thread
end of thread, other threads:[~2021-09-05 10:32 UTC | newest]
Thread overview: 6+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
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
2021-09-05 10:11 ` Eli Zaretskii
2021-09-05 10:13 ` Lars Ingebrigtsen
2021-09-05 10:32 ` Eli Zaretskii
Code repositories for project(s) associated with this public inbox
https://git.savannah.gnu.org/cgit/emacs.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).