unofficial mirror of bug-gnu-emacs@gnu.org 
 help / color / mirror / code / Atom feed
From: "Drew Adams" <drew.adams@oracle.com>
To: 12853@debbugs.gnu.org
Subject: bug#12853: 24.2.50; doc of `color-defined-p'
Date: Sat, 10 Nov 2012 08:46:24 -0800	[thread overview]
Message-ID: <10495ABA26F14041A1E374AC3B820F6E@us.oracle.com> (raw)

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@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'
 






             reply	other threads:[~2012-11-10 16:46 UTC|newest]

Thread overview: 9+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2012-11-10 16:46 Drew Adams [this message]
2012-11-10 17:50 ` bug#12853: 24.2.50; doc of `color-defined-p' Eli Zaretskii
2012-11-10 18:12   ` Drew Adams
2012-11-10 18:33     ` Eli Zaretskii
2012-11-10 18:56       ` Drew Adams
2012-11-10 19:17         ` Eli Zaretskii
2012-11-10 19:51           ` Drew Adams
2012-11-10 20:25             ` Eli Zaretskii
2012-11-23  7:56 ` Chong Yidong

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: https://www.gnu.org/software/emacs/

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=10495ABA26F14041A1E374AC3B820F6E@us.oracle.com \
    --to=drew.adams@oracle.com \
    --cc=12853@debbugs.gnu.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this public inbox

	https://git.savannah.gnu.org/cgit/emacs.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).