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

Previous Next

To add a comment to this bug, you must first unarchive it, by sending
a message to control AT debbugs.gnu.org, with unarchive 9876 in the body.
You can then email your comments to 9876 AT debbugs.gnu.org in the normal way.

Toggle the display of automated, internal messages from the tracker.

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

From: "Drew Adams" <drew.adams <at> oracle.com>
To: <bug-gnu-emacs <at> gnu.org>
Subject: 24.0.90; doc for `define-derived-mode'
Date: Wed, 26 Oct 2011 10:42:27 -0700

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.
 
In GNU Emacs 24.0.90.1 (i386-mingw-nt5.1.2600)
 of 2011-10-24 on MARVIN
Windowing system distributor `Microsoft Corp.', version 5.1.2600
configured using `configure --with-gcc (4.6) --no-opt --cflags
-I"D:/devel/emacs/libs/libXpm-3.5.8/include"
-I"D:/devel/emacs/libs/libXpm-3.5.8/src"
-I"D:/devel/emacs/libs/libpng-dev_1.4.3-1/include"
-I"D:/devel/emacs/libs/zlib-dev_1.2.5-2/include"
-I"D:/devel/emacs/libs/giflib-4.1.4-1/include"
-I"D:/devel/emacs/libs/jpeg-6b-4/include"
-I"D:/devel/emacs/libs/tiff-3.8.2-1/include"
-I"D:/devel/emacs/libs/gnutls-2.10.1/include" --ldflags
-L"D:/devel/emacs/libs/gnutls-2.10.1/lib"'
 

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

From: "Drew Adams" <drew.adams <at> oracle.com>
To: <9876 <at> debbugs.gnu.org>
Subject: RE: bug#9876: 24.0.90; doc for `define-derived-mode'
Date: Sun, 16 Sep 2012 17:27:25 -0700

ping

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.