Clarify read-answer-short/use-short-answers action

* lisp/emacs-lisp/map-ynp.el (read-answer-short): Clarify what
this variable affects (bug#54754).

* src/fns.c (Fyes_or_no_p): Mention `use-short-answers'.
This commit is contained in:
Lars Ingebrigtsen 2022-04-07 13:37:16 +02:00
parent d859cdd621
commit 4c8e23d5d7
2 changed files with 11 additions and 2 deletions

View file

@ -278,11 +278,17 @@ Type \\`SPC' or \\`y' to %s the current %s;
;; For backward compatibility check if short y/n answers are preferred.
(defcustom read-answer-short 'auto
"If non-nil, `read-answer' accepts single-character answers.
"If non-nil, the `read-answer' function accepts single-character answers.
If t, accept short (single key-press) answers to the question.
If nil, require long answers. If `auto', accept short answers if
`use-short-answers' is non-nil, or the function cell of `yes-or-no-p'
is set to `y-or-n-p'."
is set to `y-or-n-p'.
Note that this variable does not affect calls to the more
commonly-used `yes-or-no-p' function; it only affects calls to
the `read-answer' function. To control whether `yes-or-no-p'
requires a long or a short answer, see the `use-short-answers'
variable."
:type '(choice (const :tag "Accept short answers" t)
(const :tag "Require long answer" nil)
(const :tag "Guess preference" auto))

View file

@ -2915,6 +2915,9 @@ it does up to one space will be removed.
The user must confirm the answer with RET, and can edit it until it
has been confirmed.
If the `use-short-answers' variable is non-nil, instead of asking for
\"yes\" or \"no\", this function will ask for \"y\" or \"n\".
If dialog boxes are supported, a dialog box will be used
if `last-nonmenu-event' is nil, and `use-dialog-box' is non-nil. */)
(Lisp_Object prompt)