GNU bug report logs - #43593
27.1; `customize-set-variable': wrong prompt for Boolean value

Previous Next

To add a comment to this bug, you must first unarchive it, by sending
a message to control AT debbugs.gnu.org, with unarchive 43593 in the body.
You can then email your comments to 43593 AT debbugs.gnu.org in the normal way.

Toggle the display of automated, internal messages from the tracker.

Message #5 received at submit <at> debbugs.gnu.org (full text, mbox):

From: Drew Adams <drew.adams <at> oracle.com>
To: bug-gnu-emacs <at> gnu.org
Subject: 27.1; `customize-set-variable': wrong prompt for Boolean value
Date: Thu, 24 Sep 2020 10:09:57 -0700 (PDT)

This bug exists since at least Emacs 22.

emacs -Q

(defcustom bar nil
  "@@@"
  :type 'boolean :group 'convenience)

M-x customize-set-variable bar
Set variable: bar

The prompt for the Boolean value is this:

[boolean] Set customized value for bar to: (y or n)

Set it to WHAT?

It turns out that `y' sets the value to `t' and `n' sets the value to
`nil'.  But there's no way of knowing that.

The fault is with function `custom-prompt-variable', or more precisely,
with `widget-prompt-value', and then with `widget-boolean-prompt-value'.
It's the latter that calls `y-or-n-p'.

The value returned by `y-or-n-p' is t or nil, which is OK.  But the
prompt and the expected inputs are wrong.

Even if the prompt said "[boolean] Set customized value for bar to `t':
(y or n)" it would be inadequate, because it suggests that if you reply
`n' then the variable value remains unchanged.  `y-or-n-p' is just wrong
here.

The comment for `widget-boolean-prompt-value' says that it toggles.  But
it does NOT toggle.  And `customize-set-variable' should NOT just toggle
the current value anyway.  It should always prompt you for the new
value, which may or may not be already the current value.  The command
needs to be consistent.

Maybe the `boolean' widget should be changed to use `widge-prompt-value,
not `widget-boolean-prompt-value' or something?  That it inherits from
the `toggle' widget is fine - that's for the Toggle button in the
Customize UI.  But `customize-set-variable' needs a better prompt
(better behavior).

In GNU Emacs 27.1 (build 1, x86_64-w64-mingw32)
 of 2020-08-12 built on CIRROCUMULUS
Repository revision: 86d8d76aa36037184db0b2897c434cdaab1a9ae8
Repository branch: HEAD
Windowing system distributor 'Microsoft Corp.', version 10.0.18362
System Description: Microsoft Windows 10 Pro (v10.0.1903.18362.1082)

Message #8 received at 43593 <at> debbugs.gnu.org (full text, mbox):

From: Eli Zaretskii <eliz <at> gnu.org>
To: Drew Adams <drew.adams <at> oracle.com>
Cc: 43593 <at> debbugs.gnu.org
Subject: Re: bug#43593: 27.1;
 `customize-set-variable': wrong prompt for Boolean value
Date: Thu, 24 Sep 2020 20:26:46 +0300

> Date: Thu, 24 Sep 2020 10:09:57 -0700 (PDT)
> From: Drew Adams <drew.adams <at> oracle.com>
> 
> emacs -Q
> 
> (defcustom bar nil
>   "@@@"
>   :type 'boolean :group 'convenience)
> 
> M-x customize-set-variable bar
> Set variable: bar
> 
> The prompt for the Boolean value is this:
> 
> [boolean] Set customized value for bar to: (y or n)
> 
> Set it to WHAT?

To 'y' or to 'n'.

FWIW, I see no problem here, and would understand immediately what is
meant.  We do this kind of "translation" of boolean values a'll the
time in Customize.  Let's keep in mind that Customize is for users
that aren't Lisp programmers, so we don't want to request them to know
what Lisp boolean data looks like.

Message #11 received at 43593 <at> debbugs.gnu.org (full text, mbox):

From: Drew Adams <drew.adams <at> oracle.com>
To: Eli Zaretskii <eliz <at> gnu.org>, Drew Adams <drew.adams <at> oracle.com>
Cc: 43593 <at> debbugs.gnu.org
Subject: RE: bug#43593: 27.1; `customize-set-variable': wrong prompt for
 Boolean value
Date: Thu, 24 Sep 2020 11:14:39 -0700 (PDT)

> FWIW, I see no problem here, and would understand immediately what is
> meant.  We do this kind of "translation" of boolean values a'll the
> time in Customize.  Let's keep in mind that Customize is for users
> that aren't Lisp programmers, so we don't want to request them to know
> what Lisp boolean data looks like.

I understand what you're saying.  I don't agree that
it's clear now for a user.

If the prompt said something like this it would be
clearer:

 Set customized value for bar to true (y) or false (n): (y or n)

It's wrong to suggest that this is about setting
the value to `y' or `n'.

And users are used to "(y or n)" being used primarily
(almost exclusively) for confirming something.

I think the (ab)use of the `y-or-n-p' UI is unhelpful
here (misleading, unclear).

Message #14 received at 43593 <at> debbugs.gnu.org (full text, mbox):

From: Lars Ingebrigtsen <larsi <at> gnus.org>
To: Drew Adams <drew.adams <at> oracle.com>
Cc: Eli Zaretskii <eliz <at> gnu.org>, 43593 <at> debbugs.gnu.org
Subject: Re: bug#43593: 27.1; `customize-set-variable': wrong prompt for
 Boolean value
Date: Sun, 06 Jun 2021 13:22:52 +0200

Drew Adams <drew.adams <at> oracle.com> writes:

> If the prompt said something like this it would be
> clearer:
>
>  Set customized value for bar to true (y) or false (n): (y or n)
>
> It's wrong to suggest that this is about setting
> the value to `y' or `n'.

Yes, I agree that it's kinda obscure.  The proposed prompt here is a bit
long though, so I've gone with this instead in Emacs 28:

"Set customized value for bar to true: (y or n)"

-- 
(domestic pets only, the antidote for overdose, milk.)
   bloggy blog: http://lars.ingebrigtsen.no

Message #19 received at 43593 <at> debbugs.gnu.org (full text, mbox):

From: Drew Adams <drew.adams <at> oracle.com>
To: Lars Ingebrigtsen <larsi <at> gnus.org>
Cc: Eli Zaretskii <eliz <at> gnu.org>,
 "43593 <at> debbugs.gnu.org" <43593 <at> debbugs.gnu.org>
Subject: RE: [External] : Re: bug#43593: 27.1; `customize-set-variable': wrong
 prompt for Boolean value
Date: Sun, 6 Jun 2021 15:17:55 +0000

> >  Set customized value for bar to true (y) or false (n): (y or n)
> 
> Yes, I agree that it's kinda obscure.  The proposed prompt here is a bit
> long though, so I've gone with this instead in Emacs 28:
> 
> "Set customized value for bar to true: (y or n)"

Yes, that's fine.  Thx.

Previous Next

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.