summaryrefslogtreecommitdiff
path: root/lisp/emacs-lisp
diff options
context:
space:
mode:
authorJuanma Barranquero <lekktu@gmail.com>2019-10-04 01:26:07 +0200
committerJuanma Barranquero <lekktu@gmail.com>2019-10-04 01:26:56 +0200
commita397fa06d18d6ae37a3a1288f269e1ae9eb3b569 (patch)
tree6e6b02ba92984f0788d9424bf67e2856c4fc4b08 /lisp/emacs-lisp
parent93dd959711222cf594051fa397d6a6e324e136fc (diff)
downloademacs-a397fa06d18d6ae37a3a1288f269e1ae9eb3b569.tar.gz
emacs-a397fa06d18d6ae37a3a1288f269e1ae9eb3b569.tar.bz2
emacs-a397fa06d18d6ae37a3a1288f269e1ae9eb3b569.zip
Improve docstrings auto-generated by `define-minor-mode'
* 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'.
Diffstat (limited to 'lisp/emacs-lisp')
-rw-r--r--lisp/emacs-lisp/easy-mmode.el16
1 files changed, 11 insertions, 5 deletions
diff --git a/lisp/emacs-lisp/easy-mmode.el b/lisp/emacs-lisp/easy-mmode.el
index 5e7b29eddf8..6d5b5141aaf 100644
--- a/lisp/emacs-lisp/easy-mmode.el
+++ b/lisp/emacs-lisp/easy-mmode.el
@@ -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)