unofficial mirror of emacs-devel@gnu.org 
 help / color / mirror / code / Atom feed
From: Drew Adams <drew.adams@oracle.com>
To: Juanma Barranquero <lekktu@gmail.com>
Cc: Stefan Monnier <monnier@iro.umontreal.ca>,
	Emacs developers <emacs-devel@gnu.org>
Subject: RE: Filling the docstring generated by define-minor-mode
Date: Mon, 10 Jun 2019 13:15:04 -0700 (PDT)	[thread overview]
Message-ID: <ab47f609-b343-499b-9b77-9a9771527919@default> (raw)
In-Reply-To: <CAAeL0SQzQuYNEuYPE7oKA6gaj0qNgq35eVx1Q-aiQOOTyf+BVA@mail.gmail.com>

> > Maybe more than such a change is needed.  I don't
> > know what gets substituted for %s here.
> 
> The minor mode name, mostly. Which can be a single, short word, or as
> long as display-fill-column-indicator, or more. Which makes finding a
> good answer for any such format impractical.

Presumably you mean `display-fill-column-indicator-mode',
which is even worse.

> > Blindly filling such stuff automatically asks for
> > trouble, IMO.
> 
> Generally speaking, I agree.

If we impose that here then a user defining a minor
mode has zero control over it.  If we don't fill
blindly then users have control.  They can do what
they think is best.

For such generated text, I think, it's best to use
text that doesn't require mentioning the particular
name at all, or mentions it just once, on a separate
line.

Trying to inject unknown names (let alone unknown
arbitrary text) into some boilerplate text, and then
filling the result, is a recipe for bad results.
And it's not really needed, is it?

The user's part of the doc string should be under
her control, and the generated part should preferably
not inject (i.e., %s) any text at all.  That should
be doable, I think.



  reply	other threads:[~2019-06-10 20:15 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 [this message]
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

  List information: https://www.gnu.org/software/emacs/

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

  git send-email \
    --in-reply-to=ab47f609-b343-499b-9b77-9a9771527919@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 public inbox

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

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).