* lisp/window.el (recenter-top-bottom): Clarify doc string.

This commit is contained in:
Eli Zaretskii 2021-02-02 18:25:31 +02:00
parent dc78f8a4ea
commit 7355209f53

View file

@ -9545,13 +9545,16 @@ cycling order is middle -> top -> bottom."
:group 'windows) :group 'windows)
(defun recenter-top-bottom (&optional arg) (defun recenter-top-bottom (&optional arg)
"Move current buffer line to the specified window line. "Scroll the window so that current line is in the middle of the window.
With no prefix argument, successive calls place point according Successive invocations scroll the window in a cyclical order to put
to the cycling order defined by `recenter-positions'. the current line at certain places within the window, as determined by
`recenter-positions'. By default, the second invocation puts the
current line at the top-most window line, the third invocation puts it
on the bottom-most window line, and then the order is reused in a
cyclical manner.
A prefix argument is handled like `recenter': With numeric prefix ARG, move current line ARG lines below the window top.
With numeric prefix ARG, move current line to window-line ARG. With plain \\[universal-argument], move current line to window center."
With plain `C-u', move current line to window center."
(interactive "P") (interactive "P")
(cond (cond
(arg (recenter arg t)) ; Always respect ARG. (arg (recenter arg t)) ; Always respect ARG.