Improve documentation of p-s-p-scroll-down-page

* lisp/pixel-scroll.el
(pixel-scroll-precision-scroll-down-page): Document unit in
which the height of the window is measured, and what manner of
height applies.  Reported by Eli Zaretskii <eliz@gnu.org>.
This commit is contained in:
Po Lu 2024-05-11 14:38:54 +08:00
parent 3ff83246c8
commit 1c4b1ce8fa

View file

@ -502,7 +502,7 @@ Otherwise, redisplay will reset the window's vscroll."
(defun pixel-scroll-precision-scroll-down-page (delta)
"Scroll the current window down by DELTA pixels.
Note that this function doesn't work if DELTA is larger than or
equal to the height of the current window."
equal to the text height of the current window in pixels."
(let* ((desired-pos (posn-at-x-y 0 (+ delta
(window-tab-line-height)
(window-header-line-height))))