From 89a82182cbca0caa19f5b9463629918b7131ef0c Mon Sep 17 00:00:00 2001 From: Stefan Kangas Date: Sun, 26 Dec 2021 01:08:33 +0100 Subject: [PATCH] Improve documentation of read-multiple-choice * doc/lispref/commands.texi (Reading One Event): Document optional third argument help-string of read-multiple-choice. --- doc/lispref/commands.texi | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/doc/lispref/commands.texi b/doc/lispref/commands.texi index 35ef61700c2..4e36d5807c1 100644 --- a/doc/lispref/commands.texi +++ b/doc/lispref/commands.texi @@ -2854,7 +2854,7 @@ causes it to evaluate @code{help-form} and display the result. It then continues to wait for a valid input character, or keyboard-quit. @end defun -@defun read-multiple-choice prompt choices +@defun read-multiple-choice prompt choices &optional help-string Ask user a multiple choice question. @var{prompt} should be a string that will be displayed as the prompt. @@ -2864,6 +2864,11 @@ entry to be displayed while prompting (if there's room, it might be shortened), and the third, optional entry is a longer explanation that will be displayed in a help buffer if the user requests more help. +If optional argument @var{help-string} is non-@code{nil}, it should be +a string with a more detailed description of all choices. It will be +displayed in a help buffer instead of the default auto-generated +description when the user types @kbd{?}. + The return value is the matching value from @var{choices}. @lisp -- 2.39.2