summaryrefslogtreecommitdiff
path: root/doc/lispref/windows.texi
diff options
context:
space:
mode:
authorEli Zaretskii <eliz@gnu.org>2018-06-17 11:19:59 +0300
committerEli Zaretskii <eliz@gnu.org>2018-06-17 11:19:59 +0300
commitffd20184ca9bb026064f28aa260f2298baeb7fc8 (patch)
tree67447e1adad5a25f9ba0285012c852aa302424de /doc/lispref/windows.texi
parentcf4dc95f166d85a90560cbb3494d2eb878185862 (diff)
downloademacs-ffd20184ca9bb026064f28aa260f2298baeb7fc8.tar.gz
Minor documentation fix
* doc/lispref/windows.texi (Window Start and End): Improve documentation and indexing of window-end.
Diffstat (limited to 'doc/lispref/windows.texi')
-rw-r--r--doc/lispref/windows.texi4
1 files changed, 3 insertions, 1 deletions
diff --git a/doc/lispref/windows.texi b/doc/lispref/windows.texi
index f5de2fc90ba..265067146da 100644
--- a/doc/lispref/windows.texi
+++ b/doc/lispref/windows.texi
@@ -3730,6 +3730,7 @@ argument @var{window}, then returns its result.
@end defun
@cindex window end position
+@cindex last visible position in a window
@defun window-end &optional window update
This function returns the position where display of its buffer ends in
@var{window}. The default for @var{window} is the selected window.
@@ -3752,7 +3753,8 @@ Even if @var{update} is non-@code{nil}, @code{window-end} does not
attempt to scroll the display if point has moved off the screen, the
way real redisplay would do. It does not alter the
@code{window-start} value. In effect, it reports where the displayed
-text will end if scrolling is not required.
+text will end if scrolling is not required. Note that the position it
+returns might be only partially visible.
@end defun
@vindex window-group-end-function