From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!not-for-mail From: "Drew Adams" Newsgroups: gmane.emacs.bugs Subject: bug#12172: 24.1.50; doc string of `special-display-popup-frame' Date: Fri, 10 Aug 2012 09:18:58 -0700 Message-ID: <2CC2CE73F0D245E6999506DD518F9416@us.oracle.com> NNTP-Posting-Host: plane.gmane.org Mime-Version: 1.0 Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7bit X-Trace: dough.gmane.org 1344615595 10521 80.91.229.3 (10 Aug 2012 16:19:55 GMT) X-Complaints-To: usenet@dough.gmane.org NNTP-Posting-Date: Fri, 10 Aug 2012 16:19:55 +0000 (UTC) To: 12172@debbugs.gnu.org Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Fri Aug 10 18:19:56 2012 Return-path: Envelope-to: geb-bug-gnu-emacs@m.gmane.org Original-Received: from lists.gnu.org ([208.118.235.17]) by plane.gmane.org with esmtp (Exim 4.69) (envelope-from ) id 1SzrwG-0006P1-NB for geb-bug-gnu-emacs@m.gmane.org; Fri, 10 Aug 2012 18:19:52 +0200 Original-Received: from localhost ([::1]:36547 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1SzrwF-0007nc-Tj for geb-bug-gnu-emacs@m.gmane.org; Fri, 10 Aug 2012 12:19:51 -0400 Original-Received: from eggs.gnu.org ([208.118.235.92]:49111) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1SzrwC-0007ms-4P for bug-gnu-emacs@gnu.org; Fri, 10 Aug 2012 12:19:50 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1SzrwA-0004tR-04 for bug-gnu-emacs@gnu.org; Fri, 10 Aug 2012 12:19:48 -0400 Original-Received: from debbugs.gnu.org ([140.186.70.43]:37649) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1Szrw9-0004tN-Sq for bug-gnu-emacs@gnu.org; Fri, 10 Aug 2012 12:19:45 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.72) (envelope-from ) id 1Szs49-0000N1-Qe for bug-gnu-emacs@gnu.org; Fri, 10 Aug 2012 12:28:01 -0400 X-Loop: help-debbugs@gnu.org Resent-From: "Drew Adams" Original-Sender: debbugs-submit-bounces@debbugs.gnu.org Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Fri, 10 Aug 2012 16:28:01 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: report 12172 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: X-Debbugs-Original-To: Original-Received: via spool by submit@debbugs.gnu.org id=B.13446160481377 (code B ref -1); Fri, 10 Aug 2012 16:28:01 +0000 Original-Received: (at submit) by debbugs.gnu.org; 10 Aug 2012 16:27:28 +0000 Original-Received: from localhost ([127.0.0.1]:47195 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.72) (envelope-from ) id 1Szs3c-0000MA-4u for submit@debbugs.gnu.org; Fri, 10 Aug 2012 12:27:28 -0400 Original-Received: from eggs.gnu.org ([208.118.235.92]:49959) by debbugs.gnu.org with esmtp (Exim 4.72) (envelope-from ) id 1Szs3Y-0000M1-O2 for submit@debbugs.gnu.org; Fri, 10 Aug 2012 12:27:26 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1SzrvX-0004kd-U3 for submit@debbugs.gnu.org; Fri, 10 Aug 2012 12:19:08 -0400 Original-Received: from lists.gnu.org ([208.118.235.17]:45927) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1SzrvX-0004kZ-Qp for submit@debbugs.gnu.org; Fri, 10 Aug 2012 12:19:07 -0400 Original-Received: from eggs.gnu.org ([208.118.235.92]:48893) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1SzrvW-0007cQ-0x for bug-gnu-emacs@gnu.org; Fri, 10 Aug 2012 12:19:07 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1SzrvT-0004jR-UT for bug-gnu-emacs@gnu.org; Fri, 10 Aug 2012 12:19:05 -0400 Original-Received: from rcsinet15.oracle.com ([148.87.113.117]:44104) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1SzrvT-0004jL-Nm for bug-gnu-emacs@gnu.org; Fri, 10 Aug 2012 12:19:03 -0400 Original-Received: from ucsinet22.oracle.com (ucsinet22.oracle.com [156.151.31.94]) by rcsinet15.oracle.com (Sentrion-MTA-4.2.2/Sentrion-MTA-4.2.2) with ESMTP id q7AGJ29G014278 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-SHA bits=256 verify=OK) for ; Fri, 10 Aug 2012 16:19:02 GMT Original-Received: from acsmt358.oracle.com (acsmt358.oracle.com [141.146.40.158]) by ucsinet22.oracle.com (8.14.4+Sun/8.14.4) with ESMTP id q7AGJ1Hl018851 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-SHA bits=256 verify=NO) for ; Fri, 10 Aug 2012 16:19:02 GMT Original-Received: from abhmt102.oracle.com (abhmt102.oracle.com [141.146.116.54]) by acsmt358.oracle.com (8.12.11.20060308/8.12.11) with ESMTP id q7AGJ1Oj017361 for ; Fri, 10 Aug 2012 11:19:01 -0500 Original-Received: from dradamslap1 (/10.159.221.31) by default (Oracle Beehive Gateway v4.0) with ESMTP ; Fri, 10 Aug 2012 09:19:01 -0700 X-Mailer: Microsoft Office Outlook 11 X-MimeOLE: Produced By Microsoft MimeOLE V6.00.2900.6157 Thread-Index: Ac13E9hpeKldBxybSsyxQ38CItoYhA== X-Source-IP: ucsinet22.oracle.com [156.151.31.94] X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.6 (newer, 1) X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.6 (newer, 3) X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.13 Precedence: list X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.6 (newer, 2) X-Received-From: 140.186.70.43 X-BeenThere: bug-gnu-emacs@gnu.org List-Id: "Bug reports for GNU Emacs, the Swiss army knife of text editors" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Original-Sender: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Xref: news.gmane.org gmane.emacs.bugs:63009 Archived-At: (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@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'