Subject: bug#22210: closed (Re: bug#22210: 25.0.50; display-message-or-buffer docstring refers to wrong argument in display-buffer)

From: [email-masked] (GNU bug Tracking System)
Date: Sat, 19 Dec 2015 11:36:02 +0000

Your bug report

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

which was filed against the emacs package, has been closed.

The explanation is attached below, along with your original report.
If you require more details, please reply to [email-masked].

-- 
22210: http://debbugs.gnu.org/cgi/bugreport.cgi?bug=22210
GNU Bug Tracking System
Contact [email-masked] with problems

Subject: Re: bug#22210: 25.0.50; display-message-or-buffer docstring refers to wrong argument in display-buffer
From: Eli Zaretskii <[email-masked]>
To: Sebastian Wiesner <[email-masked]>
Cc: [email-masked]
Date: Sat, 19 Dec 2015 13:35:57 +0200
List-Id: <debbugs-submit.debbugs.gnu.org>

> From: Sebastian Wiesner <[email-masked]>
> 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.

Subject: 25.0.50; display-message-or-buffer docstring refers to wrong argument in display-buffer
From: Sebastian Wiesner <[email-masked]>
To: [email-masked]
Date: Sat, 19 Dec 2015 10:15:56 +0100
List-Id: <debbugs-submit.debbugs.gnu.org>

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