Re: RFC: defcustom display-popup-menus for display-popup-menus-p

[Ted Zlatanov <tzz@lifelogs.com>]

On Wed, 21 Dec 2016 22:49:26 +0200 Eli Zaretskii <eliz@gnu.org> wrote: 

>> From: Ted Zlatanov <tzz@lifelogs.com>
>> Date: Wed, 21 Dec 2016 15:43:53 -0500
>> 
>> I think `use-dialog-box' should be mentioned in the function docstring
>> for `read-multiple-choice' maybe? So other people catch it?

EZ> Be my guest, but IMO mentioning it will make no sense unless you also
EZ> tell that the function uses popup menus under some circumstances.

Is this OK? I tried to be as clear and concise as possible since that
function's docstring is already pretty long.

Thanks
Ted

diff --git a/lisp/emacs-lisp/subr-x.el b/lisp/emacs-lisp/subr-x.el
index fdcfa70..fb88f50 100644
--- a/lisp/emacs-lisp/subr-x.el
+++ b/lisp/emacs-lisp/subr-x.el
@@ -214,6 +214,11 @@ (defun read-multiple-choice (prompt choices)
 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.
+
 The return value is the matching entry from the CHOICES list.
 
 Usage example: