From: Drew Adams <drew.adams@oracle.com>
To: Eli Zaretskii <eliz@gnu.org>, Drew Adams <drew.adams@oracle.com>
Cc: 22206@debbugs.gnu.org
Subject: bug#22206: 25.1.50; doc string of `define-minor-mode'
Date: Fri, 18 Dec 2015 12:09:39 -0800 (PST) [thread overview]
Message-ID: <fbe22f42-8c7f-4a44-a7be-58943ade44dd@default> (raw)
In-Reply-To: <<83d1u3wo20.fsf@gnu.org>>
> > Unlike (elisp) `Defining Minor Modes', the doc string does not say that
> > LIGHTER is a string and that keyword :lighter has a string value.
> > Please mention that the value is a string.
>
> The doc string says:
> Optional LIGHTER is displayed in the mode line when the mode is on.
>
> What else could it possibly be, except a string?
Tons of things can be displayed in the mode line, including symbols.
"Displayed" does not preclude producing a string representation of
the thing to be displayed. And users of this macro should not need
to know intricacies of how things can be displayed in the mode line.
They should be told what the type of LIGHTER is, IMO.
But if you don't want to clarify this by adding one word, as in the
manual, then, well, don't.
next parent reply other threads:[~2015-12-18 20:09 UTC|newest]
Thread overview: 6+ messages / expand[flat|nested] mbox.gz Atom feed top
[not found] <<ff72fa4b-8ee6-4671-891e-69131e00eb16@default>
[not found] ` <<83d1u3wo20.fsf@gnu.org>
2015-12-18 20:09 ` Drew Adams [this message]
2015-12-18 17:52 bug#22206: 25.1.50; doc string of `define-minor-mode' Drew Adams
2015-12-18 19:32 ` Eli Zaretskii
2015-12-18 19:41 ` Dmitry Gutov
2015-12-18 19:44 ` Eli Zaretskii
2015-12-18 20:11 ` Drew Adams
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=fbe22f42-8c7f-4a44-a7be-58943ade44dd@default \
--to=drew.adams@oracle.com \
--cc=22206@debbugs.gnu.org \
--cc=eliz@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).