From: martin rudalics <rudalics@gmx.at>
To: Eli Zaretskii <eliz@gnu.org>
Cc: 9875@debbugs.gnu.org
Subject: bug#9875: 24.0.90; Confusing description of the "window tree" in ELisp manual
Date: Thu, 27 Oct 2011 15:16:40 +0200 [thread overview]
Message-ID: <4EA959B8.4030402@gmx.at> (raw)
In-Reply-To: <E1RJNlu-0000Kx-K9@fencepost.gnu.org>
> It's clear that representing the non-leaf nodes as window objects was
> chosen because it's convenient from the implementation POV. But that
> doesn't mean we need to expose this to every place where we describe
> how windows are split and resized.
True. But the Elisp manual is about reading and writing Elisp code.
And the necessary distinction in descriptions is in just one word -
"any" or "live".
>> This is usually said in the second sentence of the doc-string. For
>> `split-window' it reads
>>
>> "WINDOW can be any window and defaults to the selected one."
>
> When J.R. Hacker reads about "any window", she will definitely have
> only live windows in mind.
And what would be so bad about that? A lost opportunity. When Joe
grows up he will read the text more carefully and maybe even appreciate
what he finds there.
>> And for `set-window-buffer' we have
>>
>> "WINDOW has to be a live window and defaults to the selected one."
>
> Which immediately begs the question "how can a window not be `live'"?
And how could you live with a text like
For practical purposes, a window exists only while it is displayed in
a frame. Once removed from the frame, the window is effectively deleted
and should not be used, _even though there may still be references to
it_ from other Lisp objects; see *Note Deleting Windows::. Restoring a
saved window configuration is the only way for a window no longer on the
screen to come back to life; see *Note Window Configurations::.
all those years?
> Simple is in the eye of the beholder.
>
> And I was talking about the manual, not the doc strings, btw.
Which have to be consistent, btw.
martin
next prev parent reply other threads:[~2011-10-27 13:16 UTC|newest]
Thread overview: 19+ messages / expand[flat|nested] mbox.gz Atom feed top
2011-10-26 11:43 bug#9875: 24.0.90; Confusing description of the "window tree" in ELisp manual Eli Zaretskii
2011-10-26 14:17 ` Stefan Monnier
2011-10-26 18:31 ` Eli Zaretskii
2011-10-26 22:21 ` Stefan Monnier
2011-10-27 7:27 ` Eli Zaretskii
2011-10-27 9:56 ` martin rudalics
2011-10-27 11:05 ` Eli Zaretskii
2011-10-27 12:36 ` Stefan Monnier
2011-10-27 12:58 ` Eli Zaretskii
2011-10-27 13:16 ` martin rudalics [this message]
2011-10-27 12:35 ` Stefan Monnier
2011-10-26 14:23 ` martin rudalics
2011-10-26 18:54 ` Eli Zaretskii
2011-10-27 9:52 ` martin rudalics
2011-10-27 11:00 ` Eli Zaretskii
2011-10-27 13:16 ` martin rudalics
2011-10-28 8:04 ` Juri Linkov
2011-10-28 9:43 ` Eli Zaretskii
2011-10-28 13:38 ` Drew Adams
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=4EA959B8.4030402@gmx.at \
--to=rudalics@gmx.at \
--cc=9875@debbugs.gnu.org \
--cc=eliz@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.