]> git.eshelyaron.com Git - emacs.git/commitdiff
Improve `define-globalized-minor-mode' doc strings
authorLars Ingebrigtsen <larsi@gnus.org>
Wed, 4 Aug 2021 07:38:45 +0000 (09:38 +0200)
committerLars Ingebrigtsen <larsi@gnus.org>
Wed, 4 Aug 2021 07:38:45 +0000 (09:38 +0200)
* lisp/emacs-lisp/easy-mmode.el (define-globalized-minor-mode):
Copy the description from easy-mmode--arg-docstring (bug#49843).

lisp/emacs-lisp/easy-mmode.el

index 3a00fdb454d6bf0a2c02c3043c6b8ed7b2e6a5a8..8a2b3b4626a21859e1be01348a89874480b96bc1 100644 (file)
@@ -497,8 +497,11 @@ on if the hook has explicitly disabled it.
          ,(concat (format "Toggle %s in all buffers.\n" pretty-name)
                   (internal--format-docstring-line
                    "With prefix ARG, enable %s if ARG is positive; otherwise, \
-disable it.  If called from Lisp, enable the mode if ARG is omitted or nil.\n\n"
+disable it.\n\n"
                    pretty-global-name)
+                  "If called from Lisp, toggle the mode if ARG is `toggle'.
+Enable the mode if ARG is nil, omitted, or is a positive number.
+Disable the mode if ARG is a negative number.\n\n"
                   (internal--format-docstring-line
                    "%s is enabled in all buffers where `%s' would do it.\n\n"
                    pretty-name turn-on)