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

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

[Sebastian Wiesner]

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

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

[Eli Zaretskii]

> From: Sebastian Wiesner <swiesner@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.

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

[Sebastian Wiesner]

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

>> From: Sebastian Wiesner <swiesner@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.

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

[Eli Zaretskii]

> From: Sebastian Wiesner <swiesner@lunaryorn.com>
> Date: Sat, 19 Dec 2015 12:40:28 +0100
> Cc: 22210-done@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.

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

[Sebastian Wiesner]

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

>> From: Sebastian Wiesner <swiesner@lunaryorn.com>
>> Date: Sat, 19 Dec 2015 12:40:28 +0100
>> Cc: 22210-done@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.

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

[Eli Zaretskii]

> From: Sebastian Wiesner <swiesner@lunaryorn.com>
> Date: Sat, 19 Dec 2015 14:25:51 +0100
> Cc: 22210@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.

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

[Sebastian Wiesner]

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

>> From: Sebastian Wiesner <swiesner@lunaryorn.com>
>> Date: Sat, 19 Dec 2015 14:25:51 +0100
>> Cc: 22210@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.

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

[John Wiegley]

>>>>> Sebastian Wiesner <swiesner@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