]> git.eshelyaron.com Git - emacs.git/commitdiff
Improve read-multiple-choice docstring (Bug#31628)
authorDamien Cassou <damien@cassou.me>
Mon, 28 May 2018 15:12:34 +0000 (17:12 +0200)
committerNoam Postavsky <npostavs@gmail.com>
Tue, 29 May 2018 12:17:32 +0000 (08:17 -0400)
* lisp/emacs-lisp/rmc.el (read-multiple-choice): Improve docstring.

lisp/emacs-lisp/rmc.el

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