branch: elpa/ws-butler
commit 9cff8eb0c7ed12146ce58e62ba2c8b5b218539e6
Author: Sean Whitton <spwhit...@spwhitton.name>
Commit: Sean Whitton <spwhit...@spwhitton.name>
Add a comment about define-globalized-minor-mode's :predicate param
---
ws-butler.el | 17 ++++++++++++++++-
1 file changed, 16 insertions(+), 1 deletion(-)
diff --git a/ws-butler.el b/ws-butler.el
index 302041a03d..312965225d 100644
--- a/ws-butler.el
+++ b/ws-butler.el
@@ -6,7 +6,7 @@
;; Author: Le Wang <l26w...@gmail.com>
;; Maintainer: Sean Whitton <spwhit...@spwhitton.name>
;; Package-Requires: ((emacs "24.1"))
-;; Version: 1.0
+;; Version: 1.1pre
;; URL: https://elpa.nongnu.org/nongnu/ws-butler.html
;; Keywords: text
@@ -33,6 +33,8 @@
;;; News:
+;; Ver 1.1 YYYY/MM/DD Sean Whitton
+;;
;; Ver 1.0 2025/02/18 Sean Whitton
;; Take over maintenance; maintain out of nongnu-elpa.git.
;; Bump to version 1.0: core functionality not expected to change.
@@ -291,6 +293,19 @@ only for lines modified by you."
(remove-hook 'after-revert-hook #'ws-butler-after-save t)
(remove-hook 'edit-server-done-hook #'ws-butler-before-save t)))
+;; It would be better to use a `:predicate' parameter to
+;; `define-globalized-minor-mode', and mark `ws-butler-global-exempt-modes'
+;; obsolete. We could probably still honour a user's custom
+;; `ws-butler-global-exempt-modes', if it was set, in this TURN-ON function.
+;; Here is an example of a useful custom, user-specified predicate:
+;;
+;; '((not markdown-mode
+;; message-mode
+;; lisp-interaction-mode)
+;; prog-mode conf-mode text-mode)
+;;
+;; However, this would mean bumping our minimum required Emacs version to
+;; 28.1. For a package like this one, I think it is too soon for that.
(defun ws-butler--global-mode-turn-on ()
"Enable `ws-butler-mode' unless current major mode is exempt."
(unless (apply #'derived-mode-p ws-butler-global-exempt-modes)
