From: Stefan Monnier <monnier@iro.umontreal.ca>
To: emacs-devel@gnu.org
Subject: Re: Filling the docstring generated by define-minor-mode
Date: Mon, 10 Jun 2019 13:37:00 -0400 [thread overview]
Message-ID: <jwvk1dtfiqq.fsf-monnier+emacs@gnu.org> (raw)
In-Reply-To: CAAeL0STr7AScuvCdWWLw1=y-c2Yue=-egSimwai3XeBOG1cPLA@mail.gmail.com
> Minor mode's names are often long and the result is quite ugly. An
> easy fix is simply filling the docstring afterwards:
FWIW, I've usually fixed those problems by rewriting the string
so as to make sure the %s is on a "short line". E.g.
(defconst easy-mmode--arg-docstring
"
If called interactively, toggle %s.
If a prefix ARG is provided, enable the mode if ARG is positive,
and disable it if ARG is zero or negative. If called from Lisp,
also enable the mode if ARG is omitted or nil, and toggle it
if ARG is `toggle'; disable the mode otherwise.")
-- Stefan
next prev parent reply other threads:[~2019-06-10 17:37 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 [this message]
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
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=jwvk1dtfiqq.fsf-monnier+emacs@gnu.org \
--to=monnier@iro.umontreal.ca \
--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 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).