GNU bug report logs - #74
defcustom keyword :custom-show isn't documented

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 74 in the body.
You can then email your comments to 74 AT debbugs.gnu.org in the normal way.

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

Message #5 received at submit <at> emacsbugs.donarmstrong.com (full text, mbox):

From: Reiner Steib <reinersteib+gmane <at> imap.cc>
To: emacs-devel <at> gnu.org
Subject: defcustom keyword :custom-show isn't documented
Date: Fri, 21 Mar 2008 21:35:13 +0100

Hi,

in gnus-art.el, we have...

,----
| (defcustom gnus-ignored-headers
| [...]
|   :type '(choice :custom-show nil
| 		 regexp
| 		 (repeat regexp))
|   :group 'gnus-article-hiding)
`----

Neither the doc string of `defcustom', nor the manual explains it.

Bye, Reiner.
-- 
       ,,,
      (o o)
---ooO-(_)-Ooo---  |  PGP key available  |  http://rsteib.home.pages.de/

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

From: Glenn Morris <rgm <at> gnu.org>
To: 74 <at> debbugs.gnu.org
Subject: Re: Bug#74: defcustom keyword :custom-show isn't documented
Date: Thu, 21 Jan 2010 00:08:10 -0500

reassign 74 emacs
stop

Reiner Steib wrote:

> Neither the doc string of `defcustom', nor the manual explains it.

It seems that it (:custom-show) is supposed to make the variable value
field be hidden by default when it is created. In other words, make the
custom buffer look like you have clicked the "Hide the value of this
option" button.

The idea is that when a variable has a complex value, it should be
hidden by default, to avoid cluttering up the display.

However, AFAICS it doesn't work (in Emacs 21, 22, or 23).
custom-variable-value-create only uses custom-show when a variable has a
nil :custom-state. Since variables are created with state 'unknown, it
never does anything.

Making the obvious change doesn't work (the variable is created hidden
ok, but can't be unhidden by clicking the relevant button).

Given that it seems never to have worked, I'm not sure it's worth
bothering trying to fix it. It's only used in gnus-art (and cus-edit
tries to apply it to long editable-fields).

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

From: Lars Magne Ingebrigtsen <larsi <at> gnus.org>
To: Glenn Morris <rgm <at> gnu.org>
Cc: 74 <at> debbugs.gnu.org
Subject: Re: Bug#74: defcustom keyword :custom-show isn't documented
Date: Wed, 06 Jul 2011 19:27:39 +0200

Glenn Morris <rgm <at> gnu.org> writes:

>> Neither the doc string of `defcustom', nor the manual explains it.
>
> It seems that it (:custom-show) is supposed to make the variable value
> field be hidden by default when it is created. In other words, make the
> custom buffer look like you have clicked the "Hide the value of this
> option" button.
>
> The idea is that when a variable has a complex value, it should be
> hidden by default, to avoid cluttering up the display.
>
> However, AFAICS it doesn't work (in Emacs 21, 22, or 23).
> custom-variable-value-create only uses custom-show when a variable has a
> nil :custom-state. Since variables are created with state 'unknown, it
> never does anything.
>
> Making the obvious change doesn't work (the variable is created hidden
> ok, but can't be unhidden by clicking the relevant button).
>
> Given that it seems never to have worked, I'm not sure it's worth
> bothering trying to fix it. It's only used in gnus-art (and cus-edit
> tries to apply it to long editable-fields).

Perhaps we should just remove the usages, and mark :custom-show as
obsolete?

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

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

From: Stefan Monnier <monnier <at> iro.umontreal.ca>
To: Lars Magne Ingebrigtsen <larsi <at> gnus.org>
Cc: Glenn Morris <rgm <at> gnu.org>, 74 <at> debbugs.gnu.org
Subject: Re: bug#74: defcustom keyword :custom-show isn't documented
Date: Wed, 06 Jul 2011 16:15:14 -0400

>> Given that it seems never to have worked, I'm not sure it's worth
>> bothering trying to fix it. It's only used in gnus-art (and cus-edit
>> tries to apply it to long editable-fields).
> Perhaps we should just remove the usages, and mark :custom-show as
> obsolete?

Agreed,


        Stefan

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

From: Lars Magne Ingebrigtsen <larsi <at> gnus.org>
To: Stefan Monnier <monnier <at> iro.umontreal.ca>
Cc: Glenn Morris <rgm <at> gnu.org>, 74 <at> debbugs.gnu.org
Subject: Re: bug#74: defcustom keyword :custom-show isn't documented
Date: Thu, 07 Jul 2011 17:59:58 +0200

Stefan Monnier <monnier <at> iro.umontreal.ca> writes:

>>> Given that it seems never to have worked, I'm not sure it's worth
>>> bothering trying to fix it. It's only used in gnus-art (and cus-edit
>>> tries to apply it to long editable-fields).
>> Perhaps we should just remove the usages, and mark :custom-show as
>> obsolete?
>
> Agreed,

I've now added a comment to the definition of the :custom-show widget,
and marked the `custom-show' function as obsolete.

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

Previous Next

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