From: "Drew Adams" <drew.adams@oracle.com>
To: 10909@debbugs.gnu.org
Subject: bug#10909: 24.0.94; doc of `define-minor-mode'
Date: Tue, 28 Feb 2012 18:54:47 -0800 [thread overview]
Message-ID: <B15C223F7CE9400B813E358D4358F684@us.oracle.com> (raw)
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'
next reply other threads:[~2012-02-29 2:54 UTC|newest]
Thread overview: 4+ messages / expand[flat|nested] mbox.gz Atom feed top
2012-02-29 2:54 Drew Adams [this message]
2012-09-22 15:25 ` bug#10909: 24.0.94; doc of `define-minor-mode' Chong Yidong
2012-09-23 15:25 ` Stefan Monnier
2012-09-23 18:05 ` Drew Adams
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=B15C223F7CE9400B813E358D4358F684@us.oracle.com \
--to=drew.adams@oracle.com \
--cc=10909@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).