aboutsummaryrefslogtreecommitdiffstats
path: root/src
diff options
context:
space:
mode:
authorBasil L. Contovounesios2018-05-03 13:52:20 +0100
committerNoam Postavsky2018-05-10 19:04:11 -0400
commitd5cf1b3160a5510198fc5dd4e28b3eca7aadf71b (patch)
tree557d7cbce4e09fdde16e484967a41da632ae6917 /src
parentdc9188ada522743dd9c9a6658570d9c4973be432 (diff)
downloademacs-d5cf1b3160a5510198fc5dd4e28b3eca7aadf71b.tar.gz
emacs-d5cf1b3160a5510198fc5dd4e28b3eca7aadf71b.zip
Improve documentation for "other window" scrolling
* doc/emacs/windows.texi (Other Window): * doc/lispref/windows.texi (Textual Scrolling): Document scroll-other-window-down. * doc/lispref/minibuf.texi (Minibuffer Misc): Cross-reference minibuffer-scroll-window with Textual Scrolling. * src/window.c (Fother_window_for_scrolling): Clarify how "other window" is determined in docstring. (Fscroll_other_window): Simplify docstring, pointing to that of Fother_window_for_scrolling. (bug#30207)
Diffstat (limited to 'src')
-rw-r--r--src/window.c27
1 files changed, 13 insertions, 14 deletions
diff --git a/src/window.c b/src/window.c
index 59c94220294..af317674bb6 100644
--- a/src/window.c
+++ b/src/window.c
@@ -5696,11 +5696,12 @@ When calling from a program, supply as argument a number, nil, or `-'. */)
5696 5696
5697DEFUN ("other-window-for-scrolling", Fother_window_for_scrolling, Sother_window_for_scrolling, 0, 0, 0, 5697DEFUN ("other-window-for-scrolling", Fother_window_for_scrolling, Sother_window_for_scrolling, 0, 0, 0,
5698 doc: /* Return the other window for \"other window scroll\" commands. 5698 doc: /* Return the other window for \"other window scroll\" commands.
5699If `other-window-scroll-buffer' is non-nil, a window
5700showing that buffer is used.
5701If in the minibuffer, `minibuffer-scroll-window' if non-nil 5699If in the minibuffer, `minibuffer-scroll-window' if non-nil
5702specifies the window. This takes precedence over 5700specifies the window.
5703`other-window-scroll-buffer'. */) 5701Otherwise, if `other-window-scroll-buffer' is non-nil, a window
5702showing that buffer is used, popping the buffer up if necessary.
5703Finally, look for a neighboring window on the selected frame,
5704followed by all visible frames on the current terminal. */)
5704 (void) 5705 (void)
5705{ 5706{
5706 Lisp_Object window; 5707 Lisp_Object window;
@@ -5739,16 +5740,14 @@ specifies the window. This takes precedence over
5739DEFUN ("scroll-other-window", Fscroll_other_window, Sscroll_other_window, 0, 1, "P", 5740DEFUN ("scroll-other-window", Fscroll_other_window, Sscroll_other_window, 0, 1, "P",
5740 doc: /* Scroll next window upward ARG lines; or near full screen if no ARG. 5741 doc: /* Scroll next window upward ARG lines; or near full screen if no ARG.
5741A near full screen is `next-screen-context-lines' less than a full screen. 5742A near full screen is `next-screen-context-lines' less than a full screen.
5742The next window is the one below the current one; or the one at the top 5743Negative ARG means scroll downward. If ARG is the atom `-', scroll
5743if the current one is at the bottom. Negative ARG means scroll downward. 5744downward by nearly full screen. When calling from a program, supply
5744If ARG is the atom `-', scroll downward by nearly full screen. 5745as argument a number, nil, or `-'.
5745When calling from a program, supply as argument a number, nil, or `-'. 5746
5746 5747The next window is usually the one below the current one;
5747If `other-window-scroll-buffer' is non-nil, scroll the window 5748or the one at the top if the current one is at the bottom.
5748showing that buffer, popping the buffer up if necessary. 5749It is determined by the function `other-window-for-scrolling',
5749If in the minibuffer, `minibuffer-scroll-window' if non-nil 5750which see. */)
5750specifies the window to scroll. This takes precedence over
5751`other-window-scroll-buffer'. */)
5752 (Lisp_Object arg) 5751 (Lisp_Object arg)
5753{ 5752{
5754 Lisp_Object window; 5753 Lisp_Object window;