GNU bug report logs - #15717
24.3.50; document `custom-available-themes', `custom-known-themes' in Elisp manual

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 15717 in the body.
You can then email your comments to 15717 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: 24.3.50; document `custom-available-themes', `custom-known-themes' in
 Elisp manual
Date: Fri, 25 Oct 2013 08:39:02 -0700 (PDT)

These functions are as important for programmers as is `custom-theme-p'.
It is especially important to distinguish them, in particular wrt
`custom-theme-p', which uses only `custom-known-themes'.  An "available"
theme is not necessarily a "known" theme.  This can be confusing.

For example, I was doing this at first:

(defcustom doremi-custom-themes ()
  "*List of custom themes to cycle through using `doremi-custom-themes+'."
  :type '(repeat (restricted-sexp :match-alternatives (custom-theme-p)))
  :group 'doremi-misc-commands)

But what I really needed was the following, because the "available" themes
are not necessarily available from the outset - the set of "known" themes
is too limited for use here.

(defcustom doremi-custom-themes ()
  "*List of custom themes to cycle through using `doremi-custom-themes+'."
  :type '(repeat (restricted-sexp
                  :match-alternatives
                  ((lambda (s) (memq s (custom-available-themes))))))
  :group 'doremi-misc-commands)



In GNU Emacs 24.3.50.1 (i686-pc-mingw32)
 of 2013-10-19 on LEG570
Bzr revision: 114715 rgm <at> gnu.org-20131019023520-s8mwtib7xcx9e05w
Windowing system distributor `Microsoft Corp.', version 6.1.7601
Configured using:
 `configure --enable-checking 'CFLAGS=-O0 -g3' CPPFLAGS=-DGLYPH_DEBUG=1'

Message #10 received at 15717-done <at> debbugs.gnu.org (full text, mbox):

From: Chong Yidong <cyd <at> gnu.org>
To: Drew Adams <drew.adams <at> oracle.com>
Cc: 15717-done <at> debbugs.gnu.org
Subject: Re: bug#15717: 24.3.50;
 document `custom-available-themes', `custom-known-themes' in Elisp
 manual
Date: Wed, 18 Dec 2013 22:52:19 +0800

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

> These functions are as important for programmers as is
> `custom-theme-p'.  It is especially important to distinguish them, in
> particular wrt `custom-theme-p', which uses only
> `custom-known-themes'.  An "available" theme is not necessarily a
> "known" theme.  This can be confusing.

I've added custom-known-themes to the manual, and updated the docstring
of custom-available-themes to emphasize that it's meant for things like
completion.  (I don't think custom-available-themes is suitable for the
Lisp manual, but custom-theme-load-path is already documented.)

Previous Next

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