GNU bug report logs - #9564
23.3; doc of `face-list'

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 9564 in the body.
You can then email your comments to 9564 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: 23.3; doc of `face-list'
Date: Tue, 20 Sep 2011 10:32:17 -0700

Both doc string and Elisp manual say that `face-list' returns a list of
face names.  This is incorrect or at least misleading.  A "name" value
in Emacs typically refers to a string value.  The doc should say clearly
that the list elements are face _symbols_, not face "names".

In GNU Emacs 23.3.1 (i386-mingw-nt5.1.2600)
 of 2011-03-10 on 3249CTO
Windowing system distributor `Microsoft Corp.', version 5.1.2600
configured using `configure --with-gcc (4.5) --no-opt --cflags
-Ic:/imagesupport/include'
 

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

From: Stefan Monnier <monnier <at> iro.umontreal.ca>
To: "Drew Adams" <drew.adams <at> oracle.com>
Cc: 9564-done <at> debbugs.gnu.org
Subject: Re: bug#9564: 23.3; doc of `face-list'
Date: Tue, 20 Sep 2011 21:34:18 -0400

> Both doc string and Elisp manual say that `face-list' returns a list of
> face names.  This is incorrect or at least misleading.  A "name" value
> in Emacs typically refers to a string value.  The doc should say clearly
> that the list elements are face _symbols_, not face "names".

Indeed, thank you.  Actually, they're just faces.  And faces happen to
be represented by symbols.
Should be fixed now,


        Stefan

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

From: "Drew Adams" <drew.adams <at> oracle.com>
To: "'Stefan Monnier'" <monnier <at> iro.umontreal.ca>
Cc: 9564-done <at> debbugs.gnu.org
Subject: RE: bug#9564: 23.3; doc of `face-list'
Date: Tue, 20 Sep 2011 18:52:30 -0700

> > Both doc string and Elisp manual say that `face-list' 
> > returns a list of face names.  This is incorrect or at
> > least misleading.  A "name" value in Emacs typically
> > refers to a string value.  The doc should say clearly
> > that the list elements are face _symbols_, not face "names".
> 
> Indeed, thank you.  Actually, they're just faces.  And faces happen to
> be represented by symbols. Should be fixed now,

Well, yes, at one level faces are symbols - just like characters are whole
numbers.  But at another level it can be useful to distinguish the two
(conceptually).  And we do so.  In several places we speak of "face symbols".  I
think that general helps clarity rather than hurting it, but yes, at some point
users (e.g., programmers) need to understand that faces are symbols.

Another advantage in using that terminology is that while all faces are symbols,
not all symbols are faces.  Those that are can reasonably be called "face
symbols" (as we do now, in other places).

Anyway, thanks for the quick fix.

Previous Next

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