From: Lars Ingebrigtsen <larsi@gnus.org>
Date: Thu, 15 Jul 2021 09:22:52 +0000 (+0200)
Subject: Improve the `window-end' doc string
X-Git-Tag: emacs-28.0.90~1858^2
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=0848af9f6633fa997fd6390aee62e64cb226b06e;p=emacs.git

Improve the `window-end' doc string

* src/window.c (Fwindow_end): Be more explicit about what the
position is (bug#13429).
---

diff --git a/src/window.c b/src/window.c
index db324effcce..a6e8ee0d534 100644
--- a/src/window.c
+++ b/src/window.c
@@ -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;