all messages for Emacs-related lists mirrored at yhetil.org
 help / color / mirror / code / Atom feed
From: Drew Adams <drew.adams@oracle.com>
To: Juanma Barranquero <lekktu@gmail.com>,
	Stefan Monnier <monnier@iro.umontreal.ca>
Cc: Emacs developers <emacs-devel@gnu.org>
Subject: RE: Filling the docstring generated by define-minor-mode
Date: Mon, 10 Jun 2019 11:24:21 -0700 (PDT)	[thread overview]
Message-ID: <b182b1eb-4050-409f-a509-3232eabbea9c@default> (raw)
In-Reply-To: <CAAeL0SRXGd7CcqJ53B3-Oc9+4X-T38miyzTPQkGJuRGUUaQ7Cg@mail.gmail.com>

(Caveat: Haven't been following this thread.)

> > FWIW, I've usually fixed those problems by rewriting the string
> > so as to make sure the %s is on a "short line".
> 
> Fair enough, but the whole docstring, not just the part in
> easymode--arg-docstring, undergoes variable substitution.
> 
> For example, in this fragment
> 
> "Non-nil if %s is enabled.
> See the `%s' command
> for a description of this minor mode."
> 
> it's difficult to reformat it so it looks good with either very short
> or very long mode names.

 Non-nil if you have enabled
 %s.

 For a description of this minor mode see command
 `%s'.

Maybe more than such a change is needed.  I don't
know what gets substituted for %s here.

Anyway, put me in the camp that thinks that the
solution is manually rewriting the doc string.
Blindly filling such stuff automatically asks for
trouble, IMO.



  reply	other threads:[~2019-06-10 18:24 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 [this message]
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
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=b182b1eb-4050-409f-a509-3232eabbea9c@default \
    --to=drew.adams@oracle.com \
    --cc=emacs-devel@gnu.org \
    --cc=lekktu@gmail.com \
    --cc=monnier@iro.umontreal.ca \
    /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.