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

Previous Next

Full log

View this message in rfc822 format

From: help-debbugs <at> gnu.org (GNU bug Tracking System)
To: Sebastian Wiesner <swiesner <at> lunaryorn.com>
Subject: bug#22210: closed (Re: bug#22210: 25.0.50; display-message-or-buffer
 docstring refers to wrong argument in display-buffer)
Date: Sat, 19 Dec 2015 11:36:02 +0000

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

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 22210 <at> debbugs.gnu.org.

-- 
22210: http://debbugs.gnu.org/cgi/bugreport.cgi?bug=22210
GNU Bug Tracking System
Contact help-debbugs <at> gnu.org with problems

[Message part 2 (message/rfc822, inline)]

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 part 3 (message/rfc822, inline)]

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

Previous Next

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