branch: externals/jinx
commit 4c18ce95ced42639f8ef8c47a264c8c37b8b6caa
Author: Daniel Mendler <m...@daniel-mendler.de>
Commit: Daniel Mendler <m...@daniel-mendler.de>

    jinx-exclude-regexps: Expand docstring
---
 jinx.el | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)

diff --git a/jinx.el b/jinx.el
index c2312fad71..4d30a81233 100644
--- a/jinx.el
+++ b/jinx.el
@@ -163,7 +163,10 @@ checking."
        "<?[-+_.~a-zA-Z][-+_.~:a-zA-Z0-9]*@[-.a-zA-Z0-9]+>?" ;; Email
        "\\(?:Local Variables\\|End\\):\\s-*$" ;; Local variable indicator
        "jinx-\\(?:languages\\|local-words\\):\\s-+.*$")) ;; Local variables
-  "List of excluded regexps per major mode."
+  "List of excluded regexps per major mode.
+The regexp must match at the beginning of the spell-checked word.
+Therefore `jinx-exclude-regexps' cannot be used to exclude larger parts
+of a buffer.  Write a custom predicate instead, see `jinx--predicates'."
   :type '(alist :key-type symbol :value-type (choice symbol (repeat regexp))))
 
 (defcustom jinx-suggestion-distance 3

Reply via email to