--- Begin Message ---
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
--- End Message ---
--- Begin Message ---
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 <address@hidden>
> 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.
--- End Message ---