GNU bug report logs - #57499
Documentation bug in the docstring of set-face-attribute?

Previous Next

Full log

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

From: Eli Zaretskii <eliz <at> gnu.org>
To: Gregory Heytings <gregory <at> heytings.org>
Cc: 57499-done <at> debbugs.gnu.org
Subject: Re: bug#57499: Documentation bug in the docstring of
 set-face-attribute?
Date: Sat, 03 Sep 2022 09:00:41 +0300

> Date: Fri, 02 Sep 2022 20:48:06 +0000
> From: Gregory Heytings <gregory <at> heytings.org>
> cc: 57499-done <at> debbugs.gnu.org
> 
> A last suggestion: I think the docstring of set-face-attribute would be 
> even clearer with
> 
> call this function with FRAME set to t or nil, and the ATTRIBUTE's value 
> set to `unspecified'.
> 
> or with
> 
> call this function with FRAME set to t (or nil), and the ATTRIBUTE's value 
> set to `unspecified'.

That would miss the point which that part of the doc string is trying
to make: that using 'unspecified' with FRAME = t does special things.
Explaining that is the whole point of that part of the doc string.

> Just as a reminder that nil "implies" t.

Such a reminder isn't needed because just a few sentences above the
doc string said that nil implies t as well.

Previous Next

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