From: Michael Heerdegen <michael_heerdegen@web.de>
To: Drew Adams <drew.adams@oracle.com>
Cc: Lars Ingebrigtsen <larsi@gnus.org>,
Noam Postavsky <npostavs@gmail.com>,
26301@debbugs.gnu.org
Subject: bug#26301: 24.5; `define-derived-mode': different signatures for doc string & manual
Date: Sun, 28 Jul 2019 00:19:27 +0200 [thread overview]
Message-ID: <87zhkzdssw.fsf@web.de> (raw)
In-Reply-To: <7e2203c3-0855-4716-9700-d2b31b4cc4ba@default> (Drew Adams's message of "Sat, 27 Jul 2019 09:54:45 -0700 (PDT)")
Drew Adams <drew.adams@oracle.com> writes:
> > \(fn CHILD PARENT NAME [DOCSTRING] [KEYWORDS...] &rest BODY)
> >
> > So I've now done this and adjusted the rest of the doc string
> > accordingly.
>
> Sounds good. That's what I suggested, but with the
> addition of the `...' (good).
>
> However, in that case, KEYWORDS is the _wrong_ name.
In a similar case, `define-globalized-minor-mode' uses the name KEYS
(it's the name of the &rest arg though).
> The name should be KEYWORD or KEYWORD-ENTRY or KEYWORD-PAIR or some
> such.
I all find that not better. KEYWORD fails to say that values are
included. KEYWORD-ENTRY and KEYWORD-PAIR are confising, they make it
look like you would have to specify conses or two element lists.
I would prefer something like [KEYWORD VALUE ...], though I guess that
would then confuse eldoc.
Michael.
next prev parent reply other threads:[~2019-07-27 22:19 UTC|newest]
Thread overview: 12+ messages / expand[flat|nested] mbox.gz Atom feed top
2017-03-29 15:03 bug#26301: 24.5; `define-derived-mode': different signatures for doc string & manual Drew Adams
2019-07-26 11:04 ` Lars Ingebrigtsen
2019-07-26 14:50 ` Drew Adams
2019-07-26 14:54 ` Noam Postavsky
2019-07-26 15:08 ` Lars Ingebrigtsen
2019-07-26 15:51 ` Drew Adams
2019-07-26 15:38 ` Drew Adams
2019-07-27 10:03 ` Lars Ingebrigtsen
2019-07-27 16:54 ` Drew Adams
2019-07-27 22:19 ` Michael Heerdegen [this message]
2019-07-28 0:01 ` Drew Adams
2019-07-28 0:14 ` Michael Heerdegen
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=87zhkzdssw.fsf@web.de \
--to=michael_heerdegen@web.de \
--cc=26301@debbugs.gnu.org \
--cc=drew.adams@oracle.com \
--cc=larsi@gnus.org \
--cc=npostavs@gmail.com \
/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).