Skip to content

Commit 7701fca

Browse files
authored
Give all minor modes docstrings
Presently, on bleeding edge Emacs, `define-minor-mode` with an empty docstring makes the mode impossible to load as `""` is coerced to `nil` and subsequently `insert`ed, which is not kosher. The options as they stand are either a non-empty string (as I've done in this patch) or `nil`, which results in the fallback value of `Toggle <mode> on or off`. I'm not picky either way. I also sent a bug report to the Emacs list [here](https://debbugs.gnu.org/cgi/bugreport.cgi?bug=55216) so this edge case will hopefully be covered (or explicitly disallowed) in the future.
1 parent b330241 commit 7701fca

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

lsp-treemacs.el

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -582,7 +582,7 @@ will be rendered an empty line between them."
582582
m)
583583
"Keymap for `lsp-treemacs-deps-list-mode'.")
584584

585-
(define-minor-mode lsp-treemacs-deps-list-mode ""
585+
(define-minor-mode lsp-treemacs-deps-list-mode "LSP Treemacs mode for listing dependencies."
586586
:keymap lsp-treemacs-deps-list-mode-map
587587
:group 'lsp-treemacs)
588588

@@ -1315,7 +1315,7 @@ With prefix 2 show both."
13151315
m)
13161316
"Keymap for `lsp-treemacs-error-list-mode'.")
13171317

1318-
(define-minor-mode lsp-treemacs-error-list-mode ""
1318+
(define-minor-mode lsp-treemacs-error-list-mode "LSP Treemacs mode for listing errors."
13191319
:keymap lsp-treemacs-error-list-mode-map
13201320
:group 'lsp-treemacs)
13211321

0 commit comments

Comments
 (0)