GNU bug report logs - #12853
24.2.50; doc of `color-defined-p'

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#12853: closed (24.2.50; doc of `color-defined-p')
Date: Fri, 23 Nov 2012 07:59:02 +0000

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

Your message dated Fri, 23 Nov 2012 15:56:23 +0800
with message-id <87obioah20.fsf <at> gnu.org>
and subject line Re: bug#12853: 24.2.50; doc of `color-defined-p'
has caused the debbugs.gnu.org bug report #12853,
regarding 24.2.50; doc of `color-defined-p'
to be marked as done.

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


-- 
12853: http://debbugs.gnu.org/cgi/bugreport.cgi?bug=12853
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.2.50; doc of `color-defined-p'
Date: Sat, 10 Nov 2012 08:46:24 -0800

The doc string is missing the most basic information: What data type
parameter COLOR is.  It should say that COLOR must be a string or the
symbol `unspecified' (an error is raised otherwise).
 
It should say that the string can be any string, and that the function
returns non-nil for #1 or #2, and nil otherwise:
 
1. a defined (recognized) color name
2. a color RGB code, with prefix `#'
 
The doc should not say anything about the particular strings
"unspecified-fg" or "unspecified-bg": there is nothing special about
them.  The function returns nil for ANY string other than #1 or #2.
 
Consider adding to the doc string the "Note..." that is in the Elisp
manual and that refers to `color-supported-p'.
 
For the Elisp manual doc of `color-defined-p': change "X" to "X Window".  If the
same bug occurs elsewhere in the manual, please fix those occurrences too.

In GNU Emacs 24.2.50.1 (i386-mingw-nt5.1.2600)
 of 2012-10-22 on DANI-PC
Bzr revision: 110618 monnier <at> iro.umontreal.ca-20121022132928-232zm0fecassmhfb
Windowing system distributor `Microsoft Corp.', version 5.1.2600
Configured using:
 `configure --with-gcc (4.7) --no-opt --enable-checking --cflags
 -I../../libs/libxpm-3.5.8/include -I../../libs/libxpm-3.5.8/src
 -I../../libs/libpng-1.4.10 -I../../libs/zlib-1.2.6
 -I../../libs/giflib-4.1.4-1/include -I../../libs/jpeg-6b-4/include
 -I../../libs/tiff-3.8.2-1/include
 -I../../libs/libxml2-2.7.8-w32-bin/include/libxml2
 -I../../libs/gnutls-3.0.16/include
 -I../../libs/libiconv-1.14-2-mingw32-dev/include'
 

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

From: Chong Yidong <cyd <at> gnu.org>
To: "Drew Adams" <drew.adams <at> oracle.com>
Cc: 12853-done <at> debbugs.gnu.org
Subject: Re: bug#12853: 24.2.50; doc of `color-defined-p'
Date: Fri, 23 Nov 2012 15:56:23 +0800

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

> The doc string is missing the most basic information: What data type
> parameter COLOR is.  It should say that COLOR must be a string or the
> symbol `unspecified' (an error is raised otherwise).

Fixed, thanks.

Previous Next

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