GNU bug report logs - #12172
24.1.50; doc string of `special-display-popup-frame'

Previous Next

Full log

View this message in rfc822 format

From: help-debbugs <at> gnu.org (GNU bug Tracking System)
To: "Drew Adams" <drew.adams <at> oracle.com>
Subject: bug#12172: closed (Re: bug#12172: 24.1.50; doc string of
 `special-display-popup-frame')
Date: Mon, 13 Aug 2012 14:16:02 +0000

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

Your bug report

#12172: 24.1.50; doc string of `special-display-popup-frame'

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

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

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

From: Bastien <bzg <at> gnu.org>
To: "Drew Adams" <drew.adams <at> oracle.com>
Cc: 12172-done <at> debbugs.gnu.org
Subject: Re: bug#12172: 24.1.50; doc string of `special-display-popup-frame'
Date: Mon, 13 Aug 2012 16:07:47 +0200

"Drew Adams" <drew.adams <at> oracle.com> writes:

> (This is minor.)
>  
> The first line of a function's doc string should give and overall idea
> of what it does.

Done in revno#109583

I used "Pop up a frame displaying BUFFER and return its window."

Thanks,

-- 
 Bastien

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

From: "Drew Adams" <drew.adams <at> oracle.com>
To: <bug-gnu-emacs <at> gnu.org>
Subject: 24.1.50; doc string of `special-display-popup-frame'
Date: Fri, 10 Aug 2012 09:18:58 -0700

(This is minor.)
 
The first line of a function's doc string should give and overall idea
of what it does.
 
The first line of this doc string says nothing about what the function
does that makes it different from just displaying a buffer normally.
IOW, it indicates nothing about "special display" or "frame".
 
It should at least make the point that BUFFER is popped up in a frame.
That is sufficiently vague to cover all of the cases, I think, including
cases where BUFFER is already displayed somewhere: a frame showing it is
simply raised in that case.
 
Here is a suggested first line for the doc string:
 
 Pop up a frame displaying BUFFER.  Return its window.
 
Or you could move that second sentence later.

In GNU Emacs 24.1.50.1 (i386-mingw-nt5.1.2600)
 of 2012-08-08 on DANI-PC
Bzr revision: 109511 michael.albinus <at> gmx.de-20120808134045-t26l1voivvzfypey
Windowing system distributor `Microsoft Corp.', version 5.1.2600
Configured using:
 `configure --with-gcc (4.7) --no-opt --enable-checking --cflags
 -I../../libs/libxpm-3.5.8/include -I../../libs/libxpm-3.5.8/src
 -I../../libs/libpng-1.4.10 -I../../libs/zlib-1.2.6
 -I../../libs/giflib-4.1.4-1/include -I../../libs/jpeg-6b-4/include
 -I../../libs/tiff-3.8.2-1/include
 -I../../libs/libxml2-2.7.8-w32-bin/include/libxml2
 -I../../libs/gnutls-3.0.16/include
 -I../../libs/libiconv-1.14-2-mingw32-dev/include'
 

Previous Next

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