From c596111b25cc19cc31945b28dbc00a57f9172689 Mon Sep 17 00:00:00 2001
From: Neil <nyamatongwe@gmail.com>
Date: Tue, 27 Feb 2024 15:34:01 +1100
Subject: Restore change history to the extent possible when restoring undo
 history.

---
 doc/ScintillaDoc.html | 8 +++++---
 1 file changed, 5 insertions(+), 3 deletions(-)

(limited to 'doc/ScintillaDoc.html')

diff --git a/doc/ScintillaDoc.html b/doc/ScintillaDoc.html
index b866cf291..b65a9c8ef 100644
--- a/doc/ScintillaDoc.html
+++ b/doc/ScintillaDoc.html
@@ -1995,9 +1995,11 @@ struct Sci_TextToFindFull {
     <h2 id="UndoSaveRestore">Undo Save and Restore</h2>
 
     <p>This feature is unfinished and has limitations.
-    Restoring change history alongside undo state is unfinished so turn change history off before restoral.
+    When change history is active, it may show different changes than the previous session as undo actions
+    performed in that session are discarded in some circumstances such as when detaching from a save point.
+    A future version may add an API for archiving change history alongside undo history.
     The operation sequences discussed here are a 'golden path' that has been tested to some extent and calling
-    the APIs in other circumstances or with out-of-bounds values may cause failures.</p>
+    the APIs in other circumstances or with out-of-bounds values may fail.</p>
 
     <p>The behaviour of tentative actions in save and restore is uncertain as these are meant to be short-term states in language input
     and which need to synchronize with a language IME (input method editor).
@@ -2098,7 +2100,7 @@ struct Sci_TextToFindFull {
     Check for failure with <a class="seealso" href="#SCI_GETSTATUS">SCI_GETSTATUS</a>.
     </p>
 
-    <p>The current implementation may only work when the current and save point are the same and there is no tentative point.
+    <p>The current implementation may only work when there is no tentative point.
     </p>
 
     <h2 id="ChangeHistory">Change history</h2>
-- 
cgit v1.2.3