GNU bug report logs - #24879
[PATCH] Point out the default value of FRAME in the `set-face-*' functions.

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 24879 in the body.
You can then email your comments to 24879 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: Hong Xu <hong <at> topbug.net>
To: bug-gnu-emacs <at> gnu.org
Subject: [PATCH] Point out the default value of FRAME in the `set-face-*'
 functions.
Date: Fri,  4 Nov 2016 13:29:10 -0700

---

Feel free to make changes.

 doc/lispref/ChangeLog.1  | 5 +++++
 doc/lispref/display.texi | 4 ++--
 2 files changed, 7 insertions(+), 2 deletions(-)

diff --git a/doc/lispref/ChangeLog.1 b/doc/lispref/ChangeLog.1
index 610e7541e7de..e492a607368d 100644
--- a/doc/lispref/ChangeLog.1
+++ b/doc/lispref/ChangeLog.1
@@ -1,3 +1,8 @@
+2016-11-04  Hong Xu  <hong <at> topbug.net>
+
+	* display.texi (Attribute Functions): Point out the default value
+	of FRAME in the various `set-face-*` functions.
+
 2015-03-29  Glenn Morris  <rgm <at> gnu.org>
 
 	* objects.texi (Equality Predicates): Fix typo in example.
diff --git a/doc/lispref/display.texi b/doc/lispref/display.texi
index 2e316f8a532c..b19bfa9ef5c2 100644
--- a/doc/lispref/display.texi
+++ b/doc/lispref/display.texi
@@ -2644,8 +2644,8 @@ Attribute Functions
 
   The following commands and functions mostly provide compatibility
 with old versions of Emacs.  They work by calling
-@code{set-face-attribute}.  Values of @code{t} and @code{nil} for
-their @var{frame} argument are handled just like
+@code{set-face-attribute}.  Values of @code{t} and @code{nil}
+(default) for their @var{frame} argument are handled just like
 @code{set-face-attribute} and @code{face-attribute}.  The commands
 read their arguments using the minibuffer, if called interactively.
 

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

From: Eli Zaretskii <eliz <at> gnu.org>
To: Hong Xu <hong <at> topbug.net>
Cc: 24879 <at> debbugs.gnu.org
Subject: Re: bug#24879: [PATCH] Point out the default value of FRAME in the
 `set-face-*' functions.
Date: Fri, 04 Nov 2016 23:31:50 +0200

> From: Hong Xu <hong <at> topbug.net>
> Date: Fri,  4 Nov 2016 13:29:10 -0700
> 
>    The following commands and functions mostly provide compatibility
>  with old versions of Emacs.  They work by calling
> -@code{set-face-attribute}.  Values of @code{t} and @code{nil} for
> -their @var{frame} argument are handled just like
> +@code{set-face-attribute}.  Values of @code{t} and @code{nil}
> +(default) for their @var{frame} argument are handled just like
>  @code{set-face-attribute} and @code{face-attribute}.  The commands
>  read their arguments using the minibuffer, if called interactively.

Do we really need to tell people that an omitted argument defaults to
nil?  And if we do, why in this section?

Thanks.

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

From: Hong Xu <hong <at> topbug.net>
To: Eli Zaretskii <eliz <at> gnu.org>
Cc: 24879 <at> debbugs.gnu.org
Subject: Re: bug#24879: [PATCH] Point out the default value of FRAME in the
 `set-face-*' functions.
Date: Sat, 05 Nov 2016 01:17:38 -0700

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

On 2016-11-04 Fri 14:31 GMT-0700, Eli Zaretskii <eliz <at> gnu.org> wrote:

> Do we really need to tell people that an omitted argument defaults to
> nil?  And if we do, why in this section?

Hmm, I didn't notice that we don't say optional args are default to nil
in the doc. Never mind, we should close this bug.

Despite that, I sort of see some confusion in the doc when mentioning
optional args: Sometimes we say "omitted or nil" (e.g.,
face-all-attributes FRAME arg), sometimes we just say "nil" (e.g.,
face-attribute FRAME arg). Perhaps more consistency is less confusing.

[signature.asc (application/pgp-signature, inline)]

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

From: Eli Zaretskii <eliz <at> gnu.org>
To: Hong Xu <hong <at> topbug.net>
Cc: 24879-done <at> debbugs.gnu.org
Subject: Re: bug#24879: [PATCH] Point out the default value of FRAME in the
 `set-face-*' functions.
Date: Sat, 05 Nov 2016 10:56:00 +0200

> From: Hong Xu <hong <at> topbug.net>
> Cc: 24879 <at> debbugs.gnu.org
> Date: Sat, 05 Nov 2016 01:17:38 -0700
> 
> Despite that, I sort of see some confusion in the doc when mentioning
> optional args: Sometimes we say "omitted or nil" (e.g.,
> face-all-attributes FRAME arg), sometimes we just say "nil" (e.g.,
> face-attribute FRAME arg). Perhaps more consistency is less confusing.

Thanks, I made sure we mention this consistently in that node.

Previous Next

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