mirror/emacs
1
0
Fork 0
mirror of https://git.savannah.gnu.org/git/emacs.git synced 2024-11-25 07:28:20 +00:00
Code Issues Releases Activity

Disambiguate minor-mode variable in its function docstring

Browse Source 
* lisp/emacs-lisp/easy-mmode.el (easy-mmode--arg-docstring)
(easy-mmode--mode-docstring): Add "the variable" before the
GETTER if it is a symbol to properly link to minor-mode variable
in the *Help* buffer in the common case.  (bug#72405)
This commit is contained in:
Visuwesh 2024-08-14 08:07:15 +05:30 committed by Eli Zaretskii
parent 505139e0ba
commit ed8904937e
1 changed files with 6 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
lisp/emacs-lisp/easy-mmode.el
View File

@ -91,7 +91,7 @@ Enable the mode if ARG is nil, omitted, or is a positive number.
Disable the mode if ARG is a negative number.
To check whether the minor mode is enabled in the current buffer,
evaluate `%s'.
evaluate %s.
The mode's hook is called both when the mode is enabled and when
it is disabled.")
@ -128,8 +128,11 @@ it is disabled.")
easy-mmode--arg-docstring
(if global "global " "")
mode-pretty-name
;; Avoid having quotes turn into pretty quotes.
(string-replace "'" "\\='" (format "%S" getter)))))
(concat
(if (symbolp getter) "the variable ")
(format "`%s'"
;; Avoid having quotes turn into pretty quotes.
(string-replace "'" "\\='" (format "%S" getter)))))))
(let ((start (point)))
(insert argdoc)
(when (fboundp 'fill-region) ;Don't break bootstrap!