branch: elpa/spell-fu
commit 0dc0568186409fdd9c082ad3c8a61d48d5c4becf
Author: Campbell Barton <ideasma...@gmail.com>
Commit: Campbell Barton <ideasma...@gmail.com>
Update doc-string and readme for spell-fu-faces-exclude
---
readme.rst | 5 ++++-
spell-fu.el | 2 +-
2 files changed, 5 insertions(+), 2 deletions(-)
diff --git a/readme.rst b/readme.rst
index 137a5fc6cd..b8bd24128c 100644
--- a/readme.rst
+++ b/readme.rst
@@ -123,7 +123,10 @@ You may wish to set these values differently based on the
current major-mode.
When not ``nil``, only faces in this list will be checked.
``spell-fu-faces-exclude``
- When not ``nil``, text with faces in this list will be excluded.
+ When not ``nil``, text with faces in this list won't be checked.
+
+ Note that you may wish to add faces to this list if keywords or commands
are marked as being spelled incorrectly.
+ In this case, the face used by these commands may be added to this list so
as to skip them.
``global-spell-fu-ignore-buffer``
When not ``nil``, the buffer won't enable spell-checking from
``global-spell-fu-mode``.
diff --git a/spell-fu.el b/spell-fu.el
index 82a98fa16d..1ef040744f 100644
--- a/spell-fu.el
+++ b/spell-fu.el
@@ -137,7 +137,7 @@ use `spell-fu-dictionary-add'.")
"List of faces to check or nil to include all (used by
`spell-fu-check-range').")
(defvar-local spell-fu-faces-exclude nil
- "List of faces to check or nil to exclude none (used by
`spell-fu-check-range').")
+ "List of faces not to check or nil to exclude none (used by
`spell-fu-check-range').")
(defvar-local spell-fu-check-range 'spell-fu-check-range-default
"Function that takes a beginning & end points to check for the current
buffer.
