all messages for Emacs-related lists mirrored at yhetil.org
 help / color / mirror / code / Atom feed
From: Juanma Barranquero <lekktu@gmail.com>
To: Emacs developers <emacs-devel@gnu.org>
Subject: Re: Filling the docstring generated by define-minor-mode
Date: Tue, 1 Oct 2019 22:23:52 +0200	[thread overview]
Message-ID: <CAAeL0SSYmpPELa2qEKz9OTOf97yPUW+zOkn1Jq3Dp3ecoDCpAA@mail.gmail.com> (raw)
In-Reply-To: <jwv4l4wvvcr.fsf-monnier+emacs@gnu.org>

[-- Attachment #1: Type: text/plain, Size: 1688 bytes --]

Revisiting this issue...

I proposed to automatically refill the docstrings that are auto-generated
by define-minor-mode. Hand-crafted docstrings, or other doc strings outside
define-minor-mode's ones are not affected.

Obviously, as the one who proposed it, I think this is a good change for
that particular problem (and that particular problem *only*), regardless of
whether we will want to add more formatting or refilling capabilities for
docstrings in the future.

So I'd like to get a definite "ok" or "not ok" to close this issue.


diff --git i/lisp/emacs-lisp/easy-mmode.el w/lisp/emacs-lisp/easy-mmode.el
index be531aab84..fe89ed1754 100644
--- i/lisp/emacs-lisp/easy-mmode.el
+++ w/lisp/emacs-lisp/easy-mmode.el
@@ -96,9 +96,15 @@ easy-mmode--mode-docstring
     (if (string-match-p "\\bARG\\b" doc)
         doc
-      (let ((argdoc (format easy-mmode--arg-docstring
+      (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)))
-        (replace-regexp-in-string "\\(\n\n\\|\\'\\)\\(.\\|\n\\)*\\'"
-                                  (concat argdoc "\\1")
-                                  doc nil nil 1)))))
+        (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

[-- Attachment #2: Type: text/html, Size: 2130 bytes --]

  reply	other threads:[~2019-10-01 20:23 UTC|newest]

Thread overview: 18+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2019-06-10  4:55 Filling the docstring generated by define-minor-mode Juanma Barranquero
2019-06-10 10:21 ` Basil L. Contovounesios
2019-06-10 13:35   ` Juanma Barranquero
2019-06-10 17:37 ` Stefan Monnier
2019-06-10 18:08   ` Juanma Barranquero
2019-06-10 18:24     ` Drew Adams
2019-06-10 19:26       ` Juanma Barranquero
2019-06-10 20:15         ` Drew Adams
2019-06-10 20:25           ` Juanma Barranquero
2019-06-10 18:33     ` Stefan Monnier
2019-06-10 19:15       ` Juanma Barranquero
2019-06-11  7:14         ` Stefan Monnier
2019-06-11 10:37           ` Juanma Barranquero
2019-06-11 18:19             ` Stefan Monnier
2019-10-01 20:23               ` Juanma Barranquero [this message]
2019-10-01 21:04                 ` Lars Ingebrigtsen
2019-10-01 21:51                 ` Stefan Monnier
2019-10-03 23:30                   ` Juanma Barranquero

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=CAAeL0SSYmpPELa2qEKz9OTOf97yPUW+zOkn1Jq3Dp3ecoDCpAA@mail.gmail.com \
    --to=lekktu@gmail.com \
    --cc=emacs-devel@gnu.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this external index

	https://git.savannah.gnu.org/cgit/emacs.git
	https://git.savannah.gnu.org/cgit/emacs/org-mode.git

This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.