procyberian/emacs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Improve read-multiple-choice docstring (Bug#31628)

Browse source 
* lisp/emacs-lisp/rmc.el (read-multiple-choice): Improve docstring.
This commit is contained in:
Damien Cassou 2018-05-28 17:12:34 +02:00 • committed by Noam Postavsky
parent 13963a3a5c
commit 24ba63314f
1 changed files with 9 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
lisp/emacs-lisp/rmc.el
View file

@ -30,12 +30,12 @@
"Ask user a multiple choice question. "Ask user a multiple choice question.
PROMPT should be a string that will be displayed as the prompt. PROMPT should be a string that will be displayed as the prompt.
CHOICES is an alist where the first element in each entry is a CHOICES is a list of (KEY NAME [DESCRIPTION]). KEY is a
character to be entered, the second element is a short name for character to be entered. NAME is a short name for the entry to
the entry to be displayed while prompting (if there's room, it be displayed while prompting (if there's room, it might be
might be shortened), and the third, optional entry is a longer shortened). DESCRIPTION is an optional longer explanation that
explanation that will be displayed in a help buffer if the user will be displayed in a help buffer if the user requests more
requests more help. help.
This function translates user input into responses by consulting This function translates user input into responses by consulting
the bindings in `query-replace-map'; see the documentation of the bindings in `query-replace-map'; see the documentation of
@ -46,9 +46,9 @@ perform the requested window recentering or scrolling and ask
again. again.
When `use-dialog-box' is t (the default), this function can pop When `use-dialog-box' is t (the default), this function can pop
up a dialog window to collect the user input. That functionality up a dialog window to collect the user input. That functionality
requires `display-popup-menus-p' to return t. Otherwise, a text requires `display-popup-menus-p' to return t. Otherwise, a
dialog will be used. text dialog will be used.
The return value is the matching entry from the CHOICES list. The return value is the matching entry from the CHOICES list.