procyberian/emacs
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Improve docstrings auto-generated by `define-minor-mode'

Browse source 
* lisp/emacs-lisp/easy-mmode.el (easy-mmode--mode-docstring):
When using `easy-mmode--arg-docstring' to auto-generate a
docstring, refill it up to `emacs-lisp-docstring-fill-column'.
This commit is contained in:
Juanma Barranquero 2019-10-04 01:26:07 +02:00
parent 93dd959711
commit a397fa06d1
1 changed files with 11 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

16
lisp/emacs-lisp/easy-mmode.el
View file

@ -95,11 +95,17 @@ if ARG is `toggle'; disable the mode otherwise.")
\\{%s}" mode-pretty-name keymap-sym))))
(if (string-match-p "\\bARG\\b" doc)
doc
(let ((argdoc (format easy-mmode--arg-docstring
mode-pretty-name)))
(replace-regexp-in-string "\\(\n\n\\|\\'\\)\\(.\\|\n\\)*\\'"
(concat argdoc "\\1")
doc nil nil 1)))))
(let* ((fill-prefix nil)
(docstring-fc (bound-and-true-p emacs-lisp-docstring-fill-column))
(fill-column (if (integerp docstring-fc) docstring-fc 65))
(argdoc (format easy-mmode--arg-docstring
mode-pretty-name)))
(with-temp-buffer
(insert (replace-regexp-in-string "\\(\n\n\\|\\'\\)\\(.\\|\n\\)*\\'"
(concat argdoc "\\1")
doc nil nil 1))
(fill-region (point-min) (point-max) 'left t)
(buffer-string))))))
;;;###autoload
(defalias 'easy-mmode-define-minor-mode 'define-minor-mode)