From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!.POSTED!not-for-mail From: Drew Adams Newsgroups: gmane.emacs.bugs Subject: bug#28947: 26.0; doc string of `window-normalize-buffer' and similar Date: Mon, 23 Oct 2017 06:16:31 -0700 (PDT) Message-ID: <98a3ef2e-10ec-4c7e-b089-c75008ac1fdb@default> References: <59EDA2E9.902@gmx.at> NNTP-Posting-Host: blaine.gmane.org Mime-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: quoted-printable X-Trace: blaine.gmane.org 1508764649 26247 195.159.176.226 (23 Oct 2017 13:17:29 GMT) X-Complaints-To: usenet@blaine.gmane.org NNTP-Posting-Date: Mon, 23 Oct 2017 13:17:29 +0000 (UTC) To: martin rudalics , 28947@debbugs.gnu.org Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Mon Oct 23 15:17:22 2017 Return-path: Envelope-to: geb-bug-gnu-emacs@m.gmane.org Original-Received: from lists.gnu.org ([208.118.235.17]) by blaine.gmane.org with esmtp (Exim 4.84_2) (envelope-from ) id 1e6cbN-0004CQ-Nl for geb-bug-gnu-emacs@m.gmane.org; Mon, 23 Oct 2017 15:17:09 +0200 Original-Received: from localhost ([::1]:38727 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1e6cbQ-0001k6-91 for geb-bug-gnu-emacs@m.gmane.org; Mon, 23 Oct 2017 09:17:12 -0400 Original-Received: from eggs.gnu.org ([2001:4830:134:3::10]:56198) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1e6cbK-0001jz-TH for bug-gnu-emacs@gnu.org; Mon, 23 Oct 2017 09:17:07 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1e6cbG-0002pi-QI for bug-gnu-emacs@gnu.org; Mon, 23 Oct 2017 09:17:06 -0400 Original-Received: from debbugs.gnu.org ([208.118.235.43]:48043) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1e6cbG-0002pO-Lv for bug-gnu-emacs@gnu.org; Mon, 23 Oct 2017 09:17:02 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1e6cbF-0001Uf-Rs for bug-gnu-emacs@gnu.org; Mon, 23 Oct 2017 09:17:02 -0400 X-Loop: help-debbugs@gnu.org Resent-From: Drew Adams Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Mon, 23 Oct 2017 13:17:01 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 28947 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: Original-Received: via spool by 28947-submit@debbugs.gnu.org id=B28947.15087646015712 (code B ref 28947); Mon, 23 Oct 2017 13:17:01 +0000 Original-Received: (at 28947) by debbugs.gnu.org; 23 Oct 2017 13:16:41 +0000 Original-Received: from localhost ([127.0.0.1]:56724 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1e6cau-0001U4-Vk for submit@debbugs.gnu.org; Mon, 23 Oct 2017 09:16:41 -0400 Original-Received: from userp1040.oracle.com ([156.151.31.81]:48720) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1e6cau-0001Tp-3f for 28947@debbugs.gnu.org; Mon, 23 Oct 2017 09:16:40 -0400 Original-Received: from aserv0022.oracle.com (aserv0022.oracle.com [141.146.126.234]) by userp1040.oracle.com (Sentrion-MTA-4.3.2/Sentrion-MTA-4.3.2) with ESMTP id v9NDGXhF029884 (version=TLSv1.2 cipher=ECDHE-RSA-AES256-GCM-SHA384 bits=256 verify=OK); Mon, 23 Oct 2017 13:16:33 GMT Original-Received: from aserv0122.oracle.com (aserv0122.oracle.com [141.146.126.236]) by aserv0022.oracle.com (8.14.4/8.14.4) with ESMTP id v9NDGWNh022388 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-GCM-SHA384 bits=256 verify=OK); Mon, 23 Oct 2017 13:16:33 GMT Original-Received: from abhmp0002.oracle.com (abhmp0002.oracle.com [141.146.116.8]) by aserv0122.oracle.com (8.14.4/8.14.4) with ESMTP id v9NDGWjn003785; Mon, 23 Oct 2017 13:16:32 GMT In-Reply-To: <59EDA2E9.902@gmx.at> X-Priority: 3 X-Mailer: Oracle Beehive Extensions for Outlook 2.0.1.9.1 (1003210) [OL 16.0.4600.0 (x86)] X-Source-IP: aserv0022.oracle.com [141.146.126.234] X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] X-Received-From: 208.118.235.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" Xref: news.gmane.org gmane.emacs.bugs:138887 Archived-At: > I rewrote the doc-string as follows: >=20 > Return buffer specified by BUFFER-OR-NAME. > BUFFER-OR-NAME must be a live buffer, a string naming a live > buffer or nil which means to return the current buffer. >=20 > This function is commonly used to process the (usually optional) > "BUFFER-OR-NAME" argument of window related functions where nil > stands for the current buffer. > ... > Right. This should have been fixed in the release version. > ... > Done. > ... > These three functions did not have the `window-' prefix initially. The > prefix was requested by a maintainer and added later. Thanks for the quick fix. Too bad about the function names. I don't really see them as normalizing anything. And yes, they are used by window-related functions. But they are general utilities, not really having anything to do with windows. It's a bit like having a general function such as `get-buffer' defined in a Lisp library `foo.el', which is about using foos, and naming it `foo-get-buffer'. If the function is usable and useful outside foo.el then its definition belongs outside foo.el, and it shouldn't have the misleading prefix `foo-'. This (the name) is all the more important for a library named `window.el', as a window is an important, basic Emacs thingie, and functions with `window' in their name should be about Emacs windows. Perhaps our maintainer could consider changing his mind about this one? Perhaps we could move these functions out of `window.el' and rename them without prefix `window-'?