From unknown Sat Jun 21 10:31:44 2025 Content-Disposition: inline Content-Transfer-Encoding: quoted-printable MIME-Version: 1.0 X-Mailer: MIME-tools 5.509 (Entity 5.509) Content-Type: text/plain; charset=utf-8 From: bug#12172 <12172@debbugs.gnu.org> To: bug#12172 <12172@debbugs.gnu.org> Subject: Status: 24.1.50; doc string of `special-display-popup-frame' Reply-To: bug#12172 <12172@debbugs.gnu.org> Date: Sat, 21 Jun 2025 17:31:44 +0000 retitle 12172 24.1.50; doc string of `special-display-popup-frame' reassign 12172 emacs submitter 12172 "Drew Adams" severity 12172 minor thanks From debbugs-submit-bounces@debbugs.gnu.org Fri Aug 10 12:27:28 2012 Received: (at submit) by debbugs.gnu.org; 10 Aug 2012 16:27:28 +0000 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 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 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 X-Spam-Checker-Version: SpamAssassin 3.3.2 (2011-06-06) on eggs.gnu.org X-Spam-Level: X-Spam-Status: No, score=-6.9 required=5.0 tests=BAYES_00,RCVD_IN_DNSWL_HI, UNPARSEABLE_RELAY autolearn=unavailable version=3.3.2 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 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 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 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 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 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 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 Received: from dradamslap1 (/10.159.221.31) by default (Oracle Beehive Gateway v4.0) with ESMTP ; Fri, 10 Aug 2012 09:19:01 -0700 From: "Drew Adams" To: Subject: 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> MIME-Version: 1.0 Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7bit 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-Received-From: 208.118.235.17 X-Spam-Score: -6.1 (------) X-Debbugs-Envelope-To: submit X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.13 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Sender: debbugs-submit-bounces@debbugs.gnu.org Errors-To: debbugs-submit-bounces@debbugs.gnu.org X-Spam-Score: -6.1 (------) (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' From debbugs-submit-bounces@debbugs.gnu.org Mon Aug 13 10:15:57 2012 Received: (at 12172-done) by debbugs.gnu.org; 13 Aug 2012 14:15:57 +0000 Received: from localhost ([127.0.0.1]:53561 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.72) (envelope-from ) id 1T0vQz-00064E-HC for submit@debbugs.gnu.org; Mon, 13 Aug 2012 10:15:57 -0400 Received: from mail-wi0-f180.google.com ([209.85.212.180]:61403) by debbugs.gnu.org with esmtp (Exim 4.72) (envelope-from ) id 1T0vQx-000645-UR for 12172-done@debbugs.gnu.org; Mon, 13 Aug 2012 10:15:56 -0400 Received: by wibhm6 with SMTP id hm6so2758813wib.15 for <12172-done@debbugs.gnu.org>; Mon, 13 Aug 2012 07:07:22 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=googlemail.com; s=20120113; h=sender:from:to:cc:subject:in-reply-to:organization:references :user-agent:date:message-id:mime-version:content-type; bh=5O9B6lZJ+nJHoTtWn8Rticbsky8F51jK4k4g5OgjhSs=; b=mmOxl2cKDM/ORe6PRmhQMtPnC+zcoerB1Vst75lfCO5zH1kYl7+Gr0dCsqvD26py3Y wX6kxkZO40hoyjCNcHhHgwl1T5q/3rjil7R3lAkaNtJqbYZMhJ8BP6Uap+1lxWlDqRfJ SwbxImE7wq7g9vPptihkDJgUtFbSdnLDlu6dpp1Xx4R/W/83MYrOUlNfoVmW9j0rYggN CyeOWcBeRE98gAMHAkGWi01C6V4gf34JQ00In3G3E1oY20+pzIWDh1r0U0nljxD5nqIT s4EA1wHIgS6ww0zH5xlJcKTv9XQ+sHjH5TP43RTtq4LAvBq9MSBSISXk3vmAAydVHi30 Xe7A== Received: by 10.180.95.193 with SMTP id dm1mr18820359wib.10.1344866842765; Mon, 13 Aug 2012 07:07:22 -0700 (PDT) Received: from myhost.localdomain (mar75-2-81-56-68-112.fbx.proxad.net. [81.56.68.112]) by mx.google.com with ESMTPS id t8sm16623069wiy.3.2012.08.13.07.07.21 (version=TLSv1/SSLv3 cipher=OTHER); Mon, 13 Aug 2012 07:07:22 -0700 (PDT) Received: by myhost.localdomain (Postfix, from userid 1000) id 712898832; Mon, 13 Aug 2012 16:07:47 +0200 (CEST) From: Bastien To: "Drew Adams" Subject: Re: bug#12172: 24.1.50; doc string of `special-display-popup-frame' In-Reply-To: <2CC2CE73F0D245E6999506DD518F9416@us.oracle.com> (Drew Adams's message of "Fri, 10 Aug 2012 09:18:58 -0700") Organization: GNU References: <2CC2CE73F0D245E6999506DD518F9416@us.oracle.com> User-Agent: Gnus/5.130006 (Ma Gnus v0.6) Emacs/24.1.50 (gnu/linux) Date: Mon, 13 Aug 2012 16:07:47 +0200 Message-ID: <87mx1yyjf0.fsf@gnu.org> MIME-Version: 1.0 Content-Type: text/plain X-Spam-Score: -2.6 (--) X-Debbugs-Envelope-To: 12172-done Cc: 12172-done@debbugs.gnu.org X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.13 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Sender: debbugs-submit-bounces@debbugs.gnu.org Errors-To: debbugs-submit-bounces@debbugs.gnu.org X-Spam-Score: -2.6 (--) "Drew Adams" 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 From unknown Sat Jun 21 10:31:44 2025 Received: (at fakecontrol) by fakecontrolmessage; To: internal_control@debbugs.gnu.org From: Debbugs Internal Request Subject: Internal Control Message-Id: bug archived. Date: Tue, 11 Sep 2012 11:24:04 +0000 User-Agent: Fakemail v42.6.9 # This is a fake control message. # # The action: # bug archived. thanks # This fakemail brought to you by your local debbugs # administrator