GNU bug report logs - #10909
24.0.94; doc of `define-minor-mode'

Previous Next

Full log

View this message in rfc822 format

From: help-debbugs <at> gnu.org (GNU bug Tracking System)
To: Chong Yidong <cyd <at> gnu.org>
Cc: tracker <at> debbugs.gnu.org
Subject: bug#10909: closed (24.0.94; doc of `define-minor-mode')
Date: Sat, 22 Sep 2012 15:28:02 +0000

[Message part 1 (text/plain, inline)]

Your message dated Sat, 22 Sep 2012 23:25:59 +0800
with message-id <87y5k2dqpk.fsf <at> gnu.org>
and subject line Re: bug#10909: 24.0.94; doc of `define-minor-mode'
has caused the debbugs.gnu.org bug report #10909,
regarding 24.0.94; doc of `define-minor-mode'
to be marked as done.

(If you believe you have received this mail in error, please contact
help-debbugs <at> gnu.org.)


-- 
10909: http://debbugs.gnu.org/cgi/bugreport.cgi?bug=10909
GNU Bug Tracking System
Contact help-debbugs <at> gnu.org with problems

[Message part 2 (message/rfc822, inline)]

From: "Drew Adams" <drew.adams <at> oracle.com>
To: <bug-gnu-emacs <at> gnu.org>
Subject: 24.0.94; doc of `define-minor-mode'
Date: Tue, 28 Feb 2012 18:54:47 -0800

The doc says that the mode function that gets defined accepts an
optional argument.  The interactive description is OK.
 
The non-interactive description says only "When called from Lisp, it
enables the mode if the argument is omitted or nil, and toggles the mode
if the argument is `toggle'."
 
IOW, it says nothing about what happens when an arg is passed that is
not nil or omitted or `toggle'.  And I've seen at least one user try to
use `(foo-mode t)'.  It turns out that that has the same effect as
`(foo-mode 1)', but nothing in the doc says that it should.
 
The doc should, at a minimum, say what kinds of non-nil arguments it
expects (e.g. integer).
 
Personally, I think it should probably go beyond that and say also what
it does with other non-nil args, but that's your call.
 

In GNU Emacs 24.0.94.1 (i386-mingw-nt5.1.2600)
 of 2012-02-26 on MARVIN
Windowing system distributor `Microsoft Corp.', version 5.1.2600
Configured using:
 `configure --with-gcc (4.6) --no-opt --enable-checking --cflags
 -ID:/devel/emacs/libs/libXpm-3.5.8/include
 -ID:/devel/emacs/libs/libXpm-3.5.8/src
 -ID:/devel/emacs/libs/libpng-dev_1.4.3-1/include
 -ID:/devel/emacs/libs/zlib-dev_1.2.5-2/include
 -ID:/devel/emacs/libs/giflib-4.1.4-1/include
 -ID:/devel/emacs/libs/jpeg-6b-4/include
 -ID:/devel/emacs/libs/tiff-3.8.2-1/include
 -ID:/devel/emacs/libs/gnutls-3.0.9/include'
 

[Message part 3 (message/rfc822, inline)]

From: Chong Yidong <cyd <at> gnu.org>
To: "Drew Adams" <drew.adams <at> oracle.com>
Cc: 10909-done <at> debbugs.gnu.org
Subject: Re: bug#10909: 24.0.94; doc of `define-minor-mode'
Date: Sat, 22 Sep 2012 23:25:59 +0800

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

> The non-interactive description says only "When called from Lisp, it
> enables the mode if the argument is omitted or nil, and toggles the mode
> if the argument is `toggle'."
>  
> IOW, it says nothing about what happens when an arg is passed that is
> not nil or omitted or `toggle'.  And I've seen at least one user try to
> use `(foo-mode t)'.  It turns out that that has the same effect as
> `(foo-mode 1)', but nothing in the doc says that it should.

Fixed in trunk.

Previous Next

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