emacs-diffs
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[Emacs-diffs] emacs-26 24ba633: Improve read-multiple-choice docstring (


From: Noam Postavsky
Subject: [Emacs-diffs] emacs-26 24ba633: Improve read-multiple-choice docstring (Bug#31628)
Date: Tue, 29 May 2018 08:17:40 -0400 (EDT)

branch: emacs-26
commit 24ba63314f29fdffa9cfe012927e5efd744c138d
Author: Damien Cassou <address@hidden>
Commit: Noam Postavsky <address@hidden>

    Improve read-multiple-choice docstring (Bug#31628)
    
    * lisp/emacs-lisp/rmc.el (read-multiple-choice): Improve docstring.
---
 lisp/emacs-lisp/rmc.el | 18 +++++++++---------
 1 file changed, 9 insertions(+), 9 deletions(-)

diff --git a/lisp/emacs-lisp/rmc.el b/lisp/emacs-lisp/rmc.el
index 3dd3508..3197478 100644
--- a/lisp/emacs-lisp/rmc.el
+++ b/lisp/emacs-lisp/rmc.el
@@ -30,12 +30,12 @@
   "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.
 



reply via email to

[Prev in Thread] Current Thread [Next in Thread]