From: Eli Zaretskii <eliz@gnu.org>
To: Karthik Chikmagalur <karthikchikmagalur@gmail.com>
Cc: emacs-devel@gnu.org
Subject: Re: Improve other-window-for-scrolling documentation
Date: Mon, 25 Mar 2024 15:13:55 +0200 [thread overview]
Message-ID: <86le66jvxo.fsf@gnu.org> (raw)
In-Reply-To: <87il1b2jxd.fsf@gmail.com> (message from Karthik Chikmagalur on Sun, 24 Mar 2024 18:13:02 -0700)
> From: Karthik Chikmagalur <karthikchikmagalur@gmail.com>
> Date: Sun, 24 Mar 2024 18:13:02 -0700
>
> On Emacs 29.2: The documentation of other-window-for-scrolling makes no
> mention of other-window-scroll-default. Additionally, it is also
> confusing. Reproduced here:
>
> Return the other window for "other window scroll" commands.
> If in the minibuffer, ‘minibuffer-scroll-window’ if non-nil
> specifies the window.
> Otherwise, if ‘other-window-scroll-buffer’ is non-nil, a window
> showing that buffer is used, popping the buffer up if necessary.
> Finally, look for a neighboring window on the selected frame,
> followed by all visible frames on the current terminal.
>
> Looking at the source in src/window.c, the actual logic is as follows:
>
> 1. If in the minibuffer and minibuffer-scroll-window is non-nil, return
> it.
> 2. If other-window-scroll-buffer is set to a live buffer, return it.
> 3. If other-window-scroll-default is set to a function, return the
> result of calling it.
> 4. Otherwise, return a neighboring window on the same frame (if
> possible).
> 5. Otherwise, resturn a window on another visible frame in the current
> terminal (if possible).
> 6. Otherwise raise an error.
>
> Based on this, I suggest the following documentation:
>
> Return the other window for "other window scroll" commands.
> If in the minibuffer, `minibuffer-scroll-window' if non-nil
> specifies the window.
> Otherwise, if `other-window-scroll-buffer' is non-nil, a window
> showing that buffer is used, popping the buffer up if necessary.
> Otherwise, if `other-window-scroll-default' is set to a function,
> return the result of calling it.
> Finally, look for a neighboring window on the selected frame,
> followed by all visible frames on the current terminal.
Thanks, I made a similar change on the emacs-29 branch.
prev parent reply other threads:[~2024-03-25 13:13 UTC|newest]
Thread overview: 2+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-03-25 1:13 Improve other-window-for-scrolling documentation Karthik Chikmagalur
2024-03-25 13:13 ` Eli Zaretskii [this message]
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
List information: https://www.gnu.org/software/emacs/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=86le66jvxo.fsf@gnu.org \
--to=eliz@gnu.org \
--cc=emacs-devel@gnu.org \
--cc=karthikchikmagalur@gmail.com \
/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 public inbox
https://git.savannah.gnu.org/cgit/emacs.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).