GNU bug report logs - #22210
25.0.50; display-message-or-buffer docstring refers to wrong argument in display-buffer

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 22210 in the body.
You can then email your comments to 22210 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: Sebastian Wiesner <swiesner <at> lunaryorn.com>
To: bug-gnu-emacs <at> gnu.org
Subject: 25.0.50;
 display-message-or-buffer docstring refers to wrong argument in
 display-buffer
Date: Sat, 19 Dec 2015 10:15:56 +0100

The docstring of `display-message-or-buffer' reads as follows:

----

(display-message-or-buffer MESSAGE &optional BUFFER-NAME NOT-THIS-WINDOW FRAME)

[…]

Optional arguments NOT-THIS-WINDOW and FRAME are as for ‘display-buffer’,
and only used if a buffer is displayed.

----

However, display-buffer does not actually have a NOT-THIS-WINDOW argument:

(display-buffer BUFFER-OR-NAME &optional ACTION FRAME)

The source of display-message-or-buffer reveals that NOT-THIS-WINDOW is actually 
passed in the ACTION argument.

I think the argument of display-message-or-buffer should be renamed to ACTION 
as well. Currently it's pretty confusing and may lead to wrong guesses about
the semantics of this argument.

Greetings,
Sebastian

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

From: Eli Zaretskii <eliz <at> gnu.org>
To: Sebastian Wiesner <swiesner <at> lunaryorn.com>
Cc: 22210-done <at> debbugs.gnu.org
Subject: Re: bug#22210: 25.0.50;
 display-message-or-buffer docstring refers to wrong argument in
 display-buffer
Date: Sat, 19 Dec 2015 13:35:57 +0200

> From: Sebastian Wiesner <swiesner <at> lunaryorn.com>
> Date: Sat, 19 Dec 2015 10:15:56 +0100
> 
> The docstring of `display-message-or-buffer' reads as follows:
> 
> ----
> 
> (display-message-or-buffer MESSAGE &optional BUFFER-NAME NOT-THIS-WINDOW FRAME)
> 
> […]
> 
> Optional arguments NOT-THIS-WINDOW and FRAME are as for ‘display-buffer’,
> and only used if a buffer is displayed.
> 
> ----
> 
> However, display-buffer does not actually have a NOT-THIS-WINDOW argument:
> 
> (display-buffer BUFFER-OR-NAME &optional ACTION FRAME)
> 
> The source of display-message-or-buffer reveals that NOT-THIS-WINDOW is actually 
> passed in the ACTION argument.
> 
> I think the argument of display-message-or-buffer should be renamed to ACTION 
> as well.

Thanks, fixed.

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

From: Sebastian Wiesner <swiesner <at> lunaryorn.com>
To: Eli Zaretskii <eliz <at> gnu.org>
Cc: 22210-done <at> debbugs.gnu.org
Subject: Re: bug#22210: 25.0.50;
 display-message-or-buffer docstring refers to wrong argument in
 display-buffer
Date: Sat, 19 Dec 2015 12:40:28 +0100

Am 19.12.2015 um 12:35 schrieb Eli Zaretskii <eliz <at> gnu.org>:

>> From: Sebastian Wiesner <swiesner <at> lunaryorn.com>
>> Date: Sat, 19 Dec 2015 10:15:56 +0100
>> 
>> The docstring of `display-message-or-buffer' reads as follows:
>> 
>> ----
>> 
>> (display-message-or-buffer MESSAGE &optional BUFFER-NAME NOT-THIS-WINDOW FRAME)
>> 
>> […]
>> 
>> Optional arguments NOT-THIS-WINDOW and FRAME are as for ‘display-buffer’,
>> and only used if a buffer is displayed.
>> 
>> ----
>> 
>> However, display-buffer does not actually have a NOT-THIS-WINDOW argument:
>> 
>> (display-buffer BUFFER-OR-NAME &optional ACTION FRAME)
>> 
>> The source of display-message-or-buffer reveals that NOT-THIS-WINDOW is actually 
>> passed in the ACTION argument.
>> 
>> I think the argument of display-message-or-buffer should be renamed to ACTION 
>> as well.
> 
> Thanks, fixed.

Thank you for the quick fix.  Besides, I noticed that the same issue is also in the Emacs Lisp reference.

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

From: Eli Zaretskii <eliz <at> gnu.org>
To: Sebastian Wiesner <swiesner <at> lunaryorn.com>
Cc: 22210 <at> debbugs.gnu.org
Subject: Re: bug#22210: 25.0.50;
 display-message-or-buffer docstring refers to wrong argument in
 display-buffer
Date: Sat, 19 Dec 2015 14:21:21 +0200

> From: Sebastian Wiesner <swiesner <at> lunaryorn.com>
> Date: Sat, 19 Dec 2015 12:40:28 +0100
> Cc: 22210-done <at> debbugs.gnu.org
> 
> Besides, I noticed that the same issue is also in the Emacs Lisp
> reference.

Fixed as well, although it'd be better to say those things together to
begin with.

Thanks.

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

From: Sebastian Wiesner <swiesner <at> lunaryorn.com>
To: Eli Zaretskii <eliz <at> gnu.org>
Cc: 22210 <at> debbugs.gnu.org
Subject: Re: bug#22210: 25.0.50;
 display-message-or-buffer docstring refers to wrong argument in
 display-buffer
Date: Sat, 19 Dec 2015 14:25:51 +0100

Am 19.12.2015 um 13:21 schrieb Eli Zaretskii <eliz <at> gnu.org>:

>> From: Sebastian Wiesner <swiesner <at> lunaryorn.com>
>> Date: Sat, 19 Dec 2015 12:40:28 +0100
>> Cc: 22210-done <at> debbugs.gnu.org
>> 
>> Besides, I noticed that the same issue is also in the Emacs Lisp
>> reference.
> 
> Fixed as well, although it'd be better to say those things together to
> begin with.
> 
> Thanks.

I'm sorry but I didn't notice that until after you had closed the bug.  I didn't think of the
manual until now.  I apologise for having sent an incomplete bug report.

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

From: Eli Zaretskii <eliz <at> gnu.org>
To: Sebastian Wiesner <swiesner <at> lunaryorn.com>
Cc: 22210 <at> debbugs.gnu.org
Subject: Re: bug#22210: 25.0.50;
 display-message-or-buffer docstring refers to wrong argument in
 display-buffer
Date: Sat, 19 Dec 2015 16:19:43 +0200

> From: Sebastian Wiesner <swiesner <at> lunaryorn.com>
> Date: Sat, 19 Dec 2015 14:25:51 +0100
> Cc: 22210 <at> debbugs.gnu.org
> 
> > Fixed as well, although it'd be better to say those things together to
> > begin with.
> > 
> > Thanks.
> 
> I'm sorry but I didn't notice that until after you had closed the bug.  I didn't think of the
> manual until now.  I apologise for having sent an incomplete bug report.

No apology needed; mistakes do happen.

Thanks.

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

From: Sebastian Wiesner <swiesner <at> lunaryorn.com>
To: Eli Zaretskii <eliz <at> gnu.org>
Cc: 22210 <at> debbugs.gnu.org
Subject: Re: bug#22210: 25.0.50;
 display-message-or-buffer docstring refers to wrong argument in
 display-buffer
Date: Sun, 20 Dec 2015 01:04:07 +0100

Am 19.12.2015 um 15:19 schrieb Eli Zaretskii <eliz <at> gnu.org>:

>> From: Sebastian Wiesner <swiesner <at> lunaryorn.com>
>> Date: Sat, 19 Dec 2015 14:25:51 +0100
>> Cc: 22210 <at> debbugs.gnu.org
>> 
>>> Fixed as well, although it'd be better to say those things together to
>>> begin with.
>>> 
>>> Thanks.
>> 
>> I'm sorry but I didn't notice that until after you had closed the bug.  I didn't think of the
>> manual until now.  I apologise for having sent an incomplete bug report.
> 
> No apology needed; mistakes do happen.
> 
> Thanks.

Thank you, for fixing this issue so quickly, and for your great work on Emacs.

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

From: John Wiegley <jwiegley <at> gmail.com>
To: Sebastian Wiesner <swiesner <at> lunaryorn.com>
Cc: Eli Zaretskii <eliz <at> gnu.org>, 22210 <at> debbugs.gnu.org
Subject: Re: bug#22210: 25.0.50;
 display-message-or-buffer docstring refers to wrong argument in
 display-buffer
Date: Sat, 19 Dec 2015 16:16:51 -0800

>>>>> Sebastian Wiesner <swiesner <at> lunaryorn.com> writes:

> Thank you, for fixing this issue so quickly, and for your great work on
> Emacs.

A thanks Eli much deserves; I continue to become more and more aware of his
commitment and service to this community. So, accept my +1 here as well.

Nice to see you here too, Sebastian! It warms my heart to find your name in my
mailbox of core Emacs stuff. :)

-- 
John Wiegley                  GPG fingerprint = 4710 CF98 AF9B 327B B80F
http://newartisans.com                          60E1 46C4 BD1A 7AC1 4BA2

Previous Next

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