aboutsummaryrefslogtreecommitdiffstats
path: root/src
diff options
context:
space:
mode:
authorAlan Mackenzie2018-10-15 19:04:05 +0000
committerAlan Mackenzie2018-10-15 19:04:05 +0000
commit73babba26aa714c34aa8d9473ba5b55ce110a215 (patch)
treed631d44a67434a34963e162a9ccd6e9c1115bb92 /src
parentb20c51d62fe8f64b4b39183d23ec9cffd12f6852 (diff)
downloademacs-73babba26aa714c34aa8d9473ba5b55ce110a215.tar.gz
emacs-73babba26aa714c34aa8d9473ba5b55ce110a215.zip
Clarify documentation of fractional vertical scrolling and some doc strings
* doc/lispref/windows.texi (vertical scrolling): Clarify the meaning of vertical scrolling by referring to tall screen lines, images, and the display action. Clarify an ambiguous English tense. * src/window.c (window-vscroll, set-window-vscroll): Amend doc strings to refer to display.
Diffstat (limited to 'src')
-rw-r--r--src/window.c4
1 files changed, 4 insertions, 0 deletions
diff --git a/src/window.c b/src/window.c
index 409b01f302e..9026a7b5f2a 100644
--- a/src/window.c
+++ b/src/window.c
@@ -7322,6 +7322,8 @@ value. */)
7322 7322
7323DEFUN ("window-vscroll", Fwindow_vscroll, Swindow_vscroll, 0, 2, 0, 7323DEFUN ("window-vscroll", Fwindow_vscroll, Swindow_vscroll, 0, 2, 0,
7324 doc: /* Return the amount by which WINDOW is scrolled vertically. 7324 doc: /* Return the amount by which WINDOW is scrolled vertically.
7325This takes effect when displaying tall lines or images.
7326
7325If WINDOW is omitted or nil, it defaults to the selected window. 7327If WINDOW is omitted or nil, it defaults to the selected window.
7326Normally, value is a multiple of the canonical character height of WINDOW; 7328Normally, value is a multiple of the canonical character height of WINDOW;
7327optional second arg PIXELS-P means value is measured in pixels. */) 7329optional second arg PIXELS-P means value is measured in pixels. */)
@@ -7344,6 +7346,8 @@ optional second arg PIXELS-P means value is measured in pixels. */)
7344DEFUN ("set-window-vscroll", Fset_window_vscroll, Sset_window_vscroll, 7346DEFUN ("set-window-vscroll", Fset_window_vscroll, Sset_window_vscroll,
7345 2, 3, 0, 7347 2, 3, 0,
7346 doc: /* Set amount by which WINDOW should be scrolled vertically to VSCROLL. 7348 doc: /* Set amount by which WINDOW should be scrolled vertically to VSCROLL.
7349This takes effect when displaying tall lines or images.
7350
7347WINDOW nil means use the selected window. Normally, VSCROLL is a 7351WINDOW nil means use the selected window. Normally, VSCROLL is a
7348non-negative multiple of the canonical character height of WINDOW; 7352non-negative multiple of the canonical character height of WINDOW;
7349optional third arg PIXELS-P non-nil means that VSCROLL is in pixels. 7353optional third arg PIXELS-P non-nil means that VSCROLL is in pixels.