>From 2d7b6e1d9b64bb123bed898aae1a6f393d2b46ca Mon Sep 17 00:00:00 2001 From: "F. Jason Park" Date: Thu, 23 May 2024 20:50:20 -0700 Subject: [PATCH 4/7] [5.6] Mention if an ERC module is local in its doc string * lisp/erc/erc-common.el (erc--assemble-toggle) (define-erc-module): Update language of doc string to distinguish between local and global ERC modules. * test/lisp/erc/erc-tests.el (define-erc-module--global) (define-erc-module--local) (define-erc-module--local/permanent-locals): Update expected output. --- lisp/erc/erc-common.el | 8 ++++---- test/lisp/erc/erc-tests.el | 18 +++++++++--------- 2 files changed, 13 insertions(+), 13 deletions(-) diff --git a/lisp/erc/erc-common.el b/lisp/erc/erc-common.el index 4115e314b39..51a93bdaa50 100644 --- a/lisp/erc/erc-common.el +++ b/lisp/erc/erc-common.el @@ -216,7 +216,7 @@ erc--assemble-toggle `(defun ,ablsym ,(if localp `(&optional ,arg) '()) ,(erc--fill-module-docstring (if val "Enable" "Disable") - " ERC " (symbol-name name) " mode." + " ERC " (symbol-name name) " mode" (and localp " locally") "." (when localp (concat "\nWhen called interactively," " do so in all buffers for the current connection."))) @@ -413,11 +413,11 @@ define-erc-module `(progn (define-minor-mode ,mode - ,(erc--fill-module-docstring (format "Toggle ERC %s mode. -With a prefix argument ARG, enable %s if ARG is positive, + ,(erc--fill-module-docstring (format "Toggle ERC %s mode%s. +If called interactively, enable `%s' if ARG is positive, and disable it otherwise. If called from Lisp, enable the mode if ARG is omitted or nil. -\n%s" name name doc)) +\n%s" name (if local-p " locally" "") mode doc)) :global ,(not local-p) :group (erc--find-group ',name ,(and alias (list 'quote alias))) ,@(unless local-p `(:require ',(erc--find-feature name alias))) diff --git a/test/lisp/erc/erc-tests.el b/test/lisp/erc/erc-tests.el index a6e6d58cf9d..7bd5479f524 100644 --- a/test/lisp/erc/erc-tests.el +++ b/test/lisp/erc/erc-tests.el @@ -3666,9 +3666,9 @@ define-erc-module--global (define-minor-mode erc-mname-mode "Toggle ERC mname mode. -With a prefix argument ARG, enable mname if ARG is positive, and -disable it otherwise. If called from Lisp, enable the mode if -ARG is omitted or nil. +If called interactively, enable `erc-mname-mode' if ARG is +positive, and disable it otherwise. If called from Lisp, enable +the mode if ARG is omitted or nil. Some docstring." :global t @@ -3723,10 +3723,10 @@ define-erc-module--local (should (equal got `(progn (define-minor-mode erc-mname-mode - "Toggle ERC mname mode. -With a prefix argument ARG, enable mname if ARG is positive, and -disable it otherwise. If called from Lisp, enable the mode if -ARG is omitted or nil. + "Toggle ERC mname mode locally. +If called interactively, enable `erc-mname-mode' if ARG is +positive, and disable it otherwise. If called from Lisp, enable +the mode if ARG is omitted or nil. Some docstring." :global nil @@ -3737,7 +3737,7 @@ define-erc-module--local (erc-mname-disable)))) (defun erc-mname-enable (&optional ,arg-en) - "Enable ERC mname mode. + "Enable ERC mname mode locally. When called interactively, do so in all buffers for the current connection." (interactive "p") @@ -3750,7 +3750,7 @@ define-erc-module--local (ignore a) (ignore b)))) (defun erc-mname-disable (&optional ,arg-dis) - "Disable ERC mname mode. + "Disable ERC mname mode locally. When called interactively, do so in all buffers for the current connection." (interactive "p") -- 2.45.1