GNU bug report logs - #10294
24.0.92; doc string of `set-face-attribute'

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 10294 in the body.
You can then email your comments to 10294 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: 24.0.92; doc string of `set-face-attribute'
Date: Tue, 13 Dec 2011 14:18:41 -0800

The Elisp manual is clear.  The doc string is not:
 
 "FRAME nil means change attributes on all frames."
 
You must tell users just what "all frames" you have in mind here - be
explicit.  Say what the manual says:
 
 "this function sets the attributes for all existing frames, and the
  default for new frames"
 
It is quite important that by "all frames" you mean all existing frames
AND all future frames.  That is not clear, not obvious.
 
In GNU Emacs 24.0.92.1 (i386-mingw-nt5.1.2600) of 2011-12-06 on MARVIN
 Windowing system distributor `Microsoft Corp.', version 5.1.2600
 configured using `configure --with-gcc (4.6) --no-opt --cflags
 -ID:/devel/emacs/libs/libXpm-3.5.8/include
 -ID:/devel/emacs/libs/libXpm-3.5.8/src
 -ID:/devel/emacs/libs/libpng-dev_1.4.3-1/include
 -ID:/devel/emacs/libs/zlib-dev_1.2.5-2/include
 -ID:/devel/emacs/libs/giflib-4.1.4-1/include
 -ID:/devel/emacs/libs/jpeg-6b-4/include
 -ID:/devel/emacs/libs/tiff-3.8.2-1/include
 -ID:/devel/emacs/libs/gnutls-2.10.1/include --ldflags
 -LD:/devel/emacs/libs/gnutls-2.10.1/lib'
 

Message #8 received at 10294 <at> debbugs.gnu.org (full text, mbox):

From: Lars Magne Ingebrigtsen <larsi <at> gnus.org>
To: "Drew Adams" <drew.adams <at> oracle.com>
Cc: 10294 <at> debbugs.gnu.org
Subject: Re: bug#10294: 24.0.92; doc string of `set-face-attribute'
Date: Sat, 07 Jan 2012 07:01:17 +0100

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

> The Elisp manual is clear.  The doc string is not:
>
>  "FRAME nil means change attributes on all frames."
>
> You must tell users just what "all frames" you have in mind here - be
> explicit.  Say what the manual says:
>
>  "this function sets the attributes for all existing frames, and the
>   default for new frames"
>
> It is quite important that by "all frames" you mean all existing frames
> AND all future frames.  That is not clear, not obvious.

Ok; fixed.

-- 
(domestic pets only, the antidote for overdose, milk.)
  bloggy blog http://lars.ingebrigtsen.no/

Previous Next

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