From: Eli Zaretskii <eliz@gnu.org>
Date: Sat, 9 Apr 2022 09:17:49 +0000 (+0300)
Subject: ; * src/window.c (Fset_window_start): Clarify the effect of NOFORCE.
X-Git-Tag: emacs-28.1.90~150
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=9dd44505b1;p=emacs.git

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

diff --git a/src/window.c b/src/window.c
index 1e7c26b82e9..32e486f9f95 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,