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

Previous Next

Package: emacs;

Reported by: Drew Adams <drew.adams <at> oracle.com>

Date: Fri, 25 Oct 2013 15:40:01 UTC

Severity: minor

Found in version 24.3.50

Done: Chong Yidong <cyd <at> gnu.org>

Bug is archived. No further changes may be made.

Full log


View this message in rfc822 format

From: help-debbugs <at> gnu.org (GNU bug Tracking System)
To: Drew Adams <drew.adams <at> oracle.com>
Subject: bug#15717: closed (Re: bug#15717: 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 bug report

#15717: 24.3.50; document `custom-available-themes', `custom-known-themes' in Elisp manual

which was filed against the emacs package, has been closed.

The explanation is attached below, along with your original report.
If you require more details, please reply to 15717 <at> debbugs.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: 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.)

[Message part 3 (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'



This bug report was last modified 11 years and 214 days ago.

Previous Next


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