From: Eli Zaretskii <eliz@gnu.org>
Date: Fri, 15 Mar 2024 08:44:23 +0000 (+0200)
Subject: ; Fix documentation of 'flyspell-check-changes'
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=cac4567a15d9ef8da84eb834df362ee381d5b2d8;p=emacs.git

; Fix documentation of 'flyspell-check-changes'

* lisp/textmodes/flyspell.el (flyspell-check-changes): Doc fixes.

* etc/NEWS: Improve wording of entry for 'flyspell-check-changes'.

(cherry picked from commit 1c4233b9a391ba5d5746acf6b6fd4b352b8c3a58)
---

diff --git a/etc/NEWS b/etc/NEWS
index 4556ad148ef..dc7daf74d96 100644
--- a/etc/NEWS
+++ b/etc/NEWS
@@ -1230,7 +1230,8 @@ mouse to consult an error message.
 ** Flyspell
 
 *** New user option 'flyspell-check-changes'.
-It checks only edited text.
+When non-nil, Flyspell mode spell-checks only words that you edited; it
+does not check unedited words just because you move point across them.
 
 ** JS mode.
 The binding 'M-.' has been removed from the major mode keymaps in
diff --git a/lisp/textmodes/flyspell.el b/lisp/textmodes/flyspell.el
index d64e4d601f7..09d4e8a8d1a 100644
--- a/lisp/textmodes/flyspell.el
+++ b/lisp/textmodes/flyspell.el
@@ -289,8 +289,11 @@ If this variable is nil, all regions are treated as small."
   :type 'key-sequence)
 
 (defcustom flyspell-check-changes nil
-  "Check only on moving point from the edited word.
-Unlike the default behavior, don't check when moving point without editing."
+  "If non-nil, spell-check only words that were edited.
+By default, this is nil, and Flyspell checks every word across which
+you move point, even if you haven't edited the word.  Customizing this
+option to a non-nil value will not flag mis-spelled words across which
+you move point without editing them."
   :type 'boolean
   :version "30.1")
 
@@ -1000,9 +1003,10 @@ Mostly we check word delimiters."
         (setq flyspell-previous-command command)))))
 
 (defun flyspell-check-changes ()
-  "The `post-command-hook' used by flyspell to check only edits.
-It checks only on moving point from the edited word,
-not when moving point without editing."
+  "Function to spell-check only edited words when point moves off the word.
+This is installed by flyspell as `post-command-hook' when the user
+option `flyspell-check-changes' is non-nil.  It spell-checks a word
+on moving point from the word only if the word was edited before the move."
   (when flyspell-mode
     (with-local-quit
       (when (consp flyspell-changes)