GNU bug report logs - #28947
26.0; doc string of `window-normalize-buffer' and similar

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#28947: closed (Re: bug#28947: 26.0; doc string of
 `window-normalize-buffer' and similar)
Date: Tue, 31 Oct 2017 08:42:03 +0000

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

Your bug report

#28947: 26.0; doc string of `window-normalize-buffer' and similar

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

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

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

From: martin rudalics <rudalics <at> gmx.at>
To: Drew Adams <drew.adams <at> oracle.com>, 28947-done <at> debbugs.gnu.org
Subject: Re: bug#28947: 26.0; doc string of `window-normalize-buffer' and
 similar
Date: Tue, 31 Oct 2017 09:41:13 +0100

> 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-'?

Probably people don't care much so I'm closing this bug.

Thanks, martin

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

From: Drew Adams <drew.adams <at> oracle.com>
To: bug-gnu-emacs <at> gnu.org
Subject: 26.0; doc string of `window-normalize-buffer' and similar
Date: Sun, 22 Oct 2017 13:21:38 -0700 (PDT)

The doc string does not tell anything more than what the doc of
`get-buffer' tells you.  In fact, it tells you less.

Why does the function name start with `window-'?  Is it just because it
is in file window.el?  If so, consider moving it.  If the function has
some relation to a window (I don't see anything in the code that
indicates that) then please describe that in the doc string.

It looks like this should be called something like `get-live-buffer',
and the doc string should say that if no live buffer can be found then
an error is raised.

The doc string should also say explicitly that if the arg is nil then
the current buffer is returned.

Actually, if the arg is a buffer name that names a dead buffer then that
dead buffer is returned, so that wouldn't exactly be reflected in the
name `get-live-buffer'.

I wonder why that behavior.  Should the 3rd cond branch perhaps check
that the result is a live buffer (in effect using the 2nd cond branch on
the buffer gotten)?

Similar remarks apply to function `window-normalize-frame'.  Not
specific to a window.  Mention that a nil arg returns selected frame.

And similar remarks apply to function `window-normalize-window'.
In this case the function is about windows, but the suffix `-window' is
enough.  No need for prefix `window-'.


In GNU Emacs 26.0.90 (build 3, x86_64-w64-mingw32)
 of 2017-10-13
Repository revision: 906224eba147bdfc0514090064e8e8f53160f1d4
Windowing system distributor `Microsoft Corp.', version 6.1.7601
Configured using:
 `configure --without-dbus --host=x86_64-w64-mingw32
 --without-compress-install 'CFLAGS=-O2 -static -g3''

Previous Next

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