GNU bug report logs - #9876
24.0.90; doc for `define-derived-mode'

Previous Next

Full log

Message #11 received at 9876 <at> debbugs.gnu.org (full text, mbox):

From: Lars Ingebrigtsen <larsi <at> gnus.org>
To: "Drew Adams" <drew.adams <at> oracle.com>
Cc: 9876 <at> debbugs.gnu.org
Subject: Re: bug#9876: 24.0.90; doc for `define-derived-mode'
Date: Sat, 08 Feb 2014 22:04:20 -0800

"Drew Adams" <drew.adams <at> oracle.com> writes:

> The doc, in both the Elisp manual and the doc string, should say that
> parameter NAME corresponds to variable `mode-name'.
>
> Users who define major modes without using `define-derived-mode' will
> learn about `mode-name' and understand it when they need it or come in
> contact with it.  Users who use only `define-derived-mode' are ignorant
> of this connection to the variable, unless the doc points it out.
>
> Similarly, for other variables that might be concerned - e.g.,
> `major-mode'.  Such variables should be mentioned in the doc for `d-d-m'
> and the connection made to its parameters.

I think that just sounds more confusing.  The doc looks good to me the
way it is.  Closing.

-- 
(domestic pets only, the antidote for overdose, milk.)
  bloggy blog http://lars.ingebrigtsen.no/

Previous Next

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.