From: Drew Adams <drew.adams@oracle.com>
To: Eli Zaretskii <eliz@gnu.org>
Cc: 41727@debbugs.gnu.org
Subject: bug#41727: 26.3; Doc of `define-minor-mode' and minor-mode commands
Date: Sat, 6 Jun 2020 09:45:46 -0700 (PDT) [thread overview]
Message-ID: <9d7f8447-1c0b-46db-a40c-c1ed2a398c46@default> (raw)
In-Reply-To: <83k10kafha.fsf@gnu.org>
> > The doc needs improvement when describing calling the mode from Lisp.
> >
> > 1. The doc string of `define-minor-mode' says this:
> >
> > When called from Lisp, the mode command toggles the mode if the
> > argument is `toggle', disables the mode if the argument is a
> > non-positive integer, and enables the mode otherwise (including if
> > the argument is omitted or nil or a positive integer).
>
> It actually says this:
> Interactively with no prefix argument, it toggles the mode.
> A prefix argument enables the mode if the argument is positive,
> and disables it otherwise.
>
> <snipped: verbatim quote of the text I cited about Lisp call>
Yes, and? The point was about what the doc says about
a call from Lisp.
> > 3. The Elisp manual doc says this (node `Defining Minor Modes'):
> >
> > From Lisp, an argument of 'toggle' toggles the mode, whereas an
> > omitted or 'nil' argument enables the mode.
>
> It actually says this:
> The toggle command takes one optional (prefix) argument. If called
> interactively with no argument it toggles the mode on or off. A
> positive prefix argument enables the mode, any other prefix
> argument disables it.
>
> <snipped: verbatim quote of the text I cited about Lisp call>
Yes, and? The point was about what the doc says about
a call from Lisp.
The bug report doesn't find fault with the description of
the interactive behavior.
And my follow-up message suggests text for the doc string
that I think is accurate and complete, and it improves the
description of the interactive handling as well.
The bug report is about the content/message/info, though,
not the wording. If you don't like the wording of my
suggestion, some other wording that provides as accurate
and complete a description will be fine. Thx.
> Are you reading obsolete docs?
I'm reading the 26.3 docs, as suggested by the report:
In GNU Emacs 26.3 (build 1, x86_64-w64-mingw32)
of 2019-08-29
Repository revision: 96dd0196c28bc36779584e47fffcca433c9309cd
Windowing system distributor `Microsoft Corp.', version 10.0.18362
Configured using:
`configure --without-dbus --host=x86_64-w64-mingw32
--without-compress-install 'CFLAGS=-O2 -static -g3''
next prev parent reply other threads:[~2020-06-06 16:45 UTC|newest]
Thread overview: 25+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-06-05 20:39 bug#41727: 26.3; Doc of `define-minor-mode' and minor-mode commands Drew Adams
2020-06-06 0:01 ` Drew Adams
2020-06-07 10:04 ` Michael Heerdegen
2020-06-07 16:06 ` Drew Adams
2020-06-07 16:19 ` Michael Heerdegen
2020-06-07 16:30 ` Drew Adams
2020-06-06 6:13 ` Eli Zaretskii
2020-06-06 16:45 ` Drew Adams [this message]
2020-06-06 18:56 ` Eli Zaretskii
2020-06-07 10:08 ` Michael Heerdegen
2020-06-07 14:31 ` Eli Zaretskii
2020-06-07 14:45 ` Michael Heerdegen
2020-06-07 16:08 ` Drew Adams
[not found] ` <<87wo4jb33s.fsf@web.de>
[not found] ` <<83y2oz6j6x.fsf@gnu.org>
2020-06-07 16:16 ` Drew Adams
2020-06-08 17:16 ` Michael Heerdegen
2020-06-08 17:38 ` Drew Adams
2020-06-09 7:58 ` Michael Heerdegen
2020-06-09 14:39 ` Eli Zaretskii
2020-06-09 15:21 ` Michael Heerdegen
2020-06-09 15:40 ` Drew Adams
[not found] ` <<87h7vkbrh3.fsf@web.de>
[not found] ` <<835zc0717e.fsf@gnu.org>
2020-06-09 15:51 ` Drew Adams
2021-09-25 15:41 ` Stefan Kangas
2021-09-25 16:58 ` bug#41727: [External] : " Drew Adams
2021-09-25 17:18 ` Eli Zaretskii
[not found] <<963d4189-17dc-4f4e-9993-0335fa271e50@default>
[not found] ` <<83k10kafha.fsf@gnu.org>
[not found] ` <<9d7f8447-1c0b-46db-a40c-c1ed2a398c46@default>
[not found] ` <<838sh081lt.fsf@gnu.org>
2020-06-06 20:39 ` 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
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=9d7f8447-1c0b-46db-a40c-c1ed2a398c46@default \
--to=drew.adams@oracle.com \
--cc=41727@debbugs.gnu.org \
--cc=eliz@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 external index
https://git.savannah.gnu.org/cgit/emacs.git
https://git.savannah.gnu.org/cgit/emacs/org-mode.git
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.