diff options
| author | Stefan Kangas <stefan@marxist.se> | 2021-12-26 06:30:37 +0100 |
|---|---|---|
| committer | Stefan Kangas <stefan@marxist.se> | 2021-12-26 06:30:37 +0100 |
| commit | 4e2058aec33db5097edd17da8fe08bea373fd8bc (patch) | |
| tree | ad2fade110167fd88fd3f666da013e3fe7974c8a /doc/lispref/commands.texi | |
| parent | bb666073d34369606a1f446bb0f79dba388cb564 (diff) | |
| parent | 89a82182cbca0caa19f5b9463629918b7131ef0c (diff) | |
| download | emacs-4e2058aec33db5097edd17da8fe08bea373fd8bc.tar.gz emacs-4e2058aec33db5097edd17da8fe08bea373fd8bc.tar.bz2 emacs-4e2058aec33db5097edd17da8fe08bea373fd8bc.zip | |
Merge from origin/emacs-28
89a82182cb Improve documentation of read-multiple-choice
5fccd1e371 Explain why we remove stuff from 'user-full-name'
Diffstat (limited to 'doc/lispref/commands.texi')
| -rw-r--r-- | doc/lispref/commands.texi | 7 |
1 files changed, 6 insertions, 1 deletions
diff --git a/doc/lispref/commands.texi b/doc/lispref/commands.texi index 0a324a642fe..9a396f57ef0 100644 --- a/doc/lispref/commands.texi +++ b/doc/lispref/commands.texi @@ -3000,7 +3000,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. @@ -3010,6 +3010,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 |