unofficial mirror of bug-gnu-emacs@gnu.org 
 help / color / mirror / code / Atom feed
From: Drew Adams <drew.adams@oracle.com>
To: 17567@debbugs.gnu.org
Subject: bug#17567: 24.4.50; doc string of `define-derived-mode'
Date: Fri, 23 May 2014 12:35:53 -0700 (PDT)	[thread overview]
Message-ID: <8e27e542-96e8-4342-a761-8c066fe3d307@default> (raw)
In-Reply-To: <ab3ae2a9-1af0-4851-a2be-0267491138a3@default>

Also, the doc string should state the types of the values of
keywords :group, :syntax-table, and :abbrev-table.

And it says that the mode runs the hook constructed by function
`derived-mode-hook-name'.  Constructed how?  What does constructed
mean here?

And the doc string of `derived-mode-hook-name' is no help here:
"Construct a mode-hook name based on a MODE name."

The arg is MODE.  What is it?  What data type?  And what is
its "name"?  What does it mean to construct a hook name?
And how is that name constructed from the "MODE name"?

And what about the contradiction between the doc string of
`define-derived-mode' and that of `derived-mode-hook-name'?
The former says that `d-m-h-name' constructs a _hook_.  The
latter says that it constructs a hook _name_.

Far clearer for `derived-mode-hook-name' would be to just
say what it really does:

  Return a symbol whose name is "-hook" appended to the
  `symbol-name' of MODE.

That also makes it clear that MODE is expected to be a symbol.

(Similarly, for the other `defsubst's in derived.el.)





  reply	other threads:[~2014-05-23 19:35 UTC|newest]

Thread overview: 17+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2014-05-23 19:15 bug#17567: 24.4.50; doc string of `define-derived-mode' Drew Adams
2014-05-23 19:35 ` Drew Adams [this message]
2021-09-25 17:15   ` Stefan Kangas
2021-09-25 17:30     ` Eli Zaretskii
2021-09-25 18:01       ` Stefan Kangas
2021-09-25 18:46         ` Eli Zaretskii
2021-09-25 19:07           ` Stefan Kangas
2021-09-25 19:11             ` Eli Zaretskii
2021-09-25 19:38               ` Stefan Kangas
2021-09-25 17:36     ` bug#17567: [External] : " Drew Adams
2021-09-25 18:42       ` Eli Zaretskii
2021-09-25 18:59         ` Drew Adams
2021-09-25 19:05           ` Eli Zaretskii
2021-09-25 19:44             ` Drew Adams
2021-09-25 19:53               ` Eli Zaretskii
2021-09-25 21:08                 ` Drew Adams
2021-09-27 22:36                   ` Richard Stallman

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=8e27e542-96e8-4342-a761-8c066fe3d307@default \
    --to=drew.adams@oracle.com \
    --cc=17567@debbugs.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).