emacs-28 9dd44505b1: ; * src/window.c (Fset_window_start): Clarify the effect of NOFORCE.

[Eli Zaretskii]

branch: emacs-28
commit 9dd44505b1dd3564deb8964372ab8a1d1021cb33
Author: Eli Zaretskii <eliz@gnu.org>
Commit: Eli Zaretskii <eliz@gnu.org>

    ; * src/window.c (Fset_window_start): Clarify the effect of NOFORCE.
---
 src/window.c | 9 +++++++--
 1 file changed, 7 insertions(+), 2 deletions(-)

diff --git a/src/window.c b/src/window.c
index 1e7c26b82e..32e486f9f9 100644
--- a/src/window.c
+++ b/src/window.c
@@ -1850,8 +1850,13 @@ Return POS.  */)
 DEFUN ("set-window-start", Fset_window_start, Sset_window_start, 2, 3, 0,
        doc: /* Make display in WINDOW start at position POS in WINDOW's buffer.
 WINDOW must be a live window and defaults to the selected one.  Return
-POS.  Optional third arg NOFORCE non-nil inhibits next redisplay from
-overriding motion of point in order to display at this exact start.
+POS.
+
+Optional third arg NOFORCE non-nil prevents next redisplay from
+moving point if displaying the window at POS makes point invisible;
+redisplay will then choose the WINDOW's start position by itself in
+that case, i.e. it will disregard POS if adhering to it will make
+point not visible in the window.
 
 For reliable setting of WINDOW start position, make sure point is
 at a position that will be visible when that start is in effect,