all messages for Emacs-related lists mirrored at yhetil.org
 help / color / mirror / code / Atom feed
From: Drew Adams <drew.adams@oracle.com>
To: 28947@debbugs.gnu.org
Subject: bug#28947: 26.0; doc string of `window-normalize-buffer' and similar
Date: Sun, 22 Oct 2017 13:21:38 -0700 (PDT)	[thread overview]
Message-ID: <c2a45513-581e-4cdc-91e7-c93b47b67233@default> (raw)

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





             reply	other threads:[~2017-10-22 20:21 UTC|newest]

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2017-10-22 20:21 Drew Adams [this message]
2017-10-23  8:06 ` bug#28947: 26.0; doc string of `window-normalize-buffer' and similar martin rudalics
2017-10-23 13:16   ` Drew Adams
2017-10-31  8:41     ` martin rudalics

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=c2a45513-581e-4cdc-91e7-c93b47b67233@default \
    --to=drew.adams@oracle.com \
    --cc=28947@debbugs.gnu.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this external index

	https://git.savannah.gnu.org/cgit/emacs.git
	https://git.savannah.gnu.org/cgit/emacs/org-mode.git

This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.