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

Previous Next

Full log

View this message in rfc822 format

From: help-debbugs <at> gnu.org (GNU bug Tracking System)
To: Chong Yidong <cyd <at> gnu.org>
Cc: tracker <at> debbugs.gnu.org
Subject: bug#15717: closed (24.3.50; document `custom-available-themes',
 `custom-known-themes' in Elisp manual)
Date: Wed, 18 Dec 2013 14:53:02 +0000

[Message part 1 (text/plain, inline)]

Your message dated Wed, 18 Dec 2013 22:52:19 +0800
with message-id <87vbymfbz0.fsf <at> gnu.org>
and subject line Re: bug#15717: 24.3.50; document `custom-available-themes', `custom-known-themes' in Elisp manual
has caused the debbugs.gnu.org bug report #15717,
regarding 24.3.50; document `custom-available-themes', `custom-known-themes' in Elisp manual
to be marked as done.

(If you believe you have received this mail in error, please contact
help-debbugs <at> gnu.org.)


-- 
15717: http://debbugs.gnu.org/cgi/bugreport.cgi?bug=15717
GNU Bug Tracking System
Contact help-debbugs <at> gnu.org with problems

[Message part 2 (message/rfc822, inline)]

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 part 3 (message/rfc822, inline)]

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.