1
0
mirror of https://git.savannah.gnu.org/git/emacs.git synced 2025-01-30 19:53:09 +00:00

Improve the `window-end' doc string

* src/window.c (Fwindow_end): Be more explicit about what the
position is (bug#13429).
This commit is contained in:
Lars Ingebrigtsen 2021-07-15 11:22:52 +02:00
parent 4aac8f60e6
commit 0848af9f66

View File

@ -1723,14 +1723,16 @@ have been if redisplay had finished, do this:
DEFUN ("window-end", Fwindow_end, Swindow_end, 0, 2, 0,
doc: /* Return position at which display currently ends in WINDOW.
WINDOW must be a live window and defaults to the selected one.
This is updated by redisplay, when it runs to completion.
Simply changing the buffer text or setting `window-start'
does not update this value.
This is the position after the final character in WINDOW.
WINDOW must be a live window and defaults to the selected one. This
is updated by redisplay, when it runs to completion. Simply changing
the buffer text or setting `window-start' does not update this value.
Return nil if there is no recorded value. (This can happen if the
last redisplay of WINDOW was preempted, and did not finish.)
If UPDATE is non-nil, compute the up-to-date position
if it isn't already recorded. */)
last redisplay of WINDOW was preempted, and did not finish.) If
UPDATE is non-nil, compute the up-to-date position if it isn't already
recorded. */)
(Lisp_Object window, Lisp_Object update)
{
Lisp_Object value;