GNU bug report logs - #24413
24.5; doc string of `whitespace-mode' does not mention Lisp `toggle' arg

Previous Next

Package: emacs;

Reported by: Drew Adams <drew.adams <at> oracle.com>

Date: Sun, 11 Sep 2016 16:54:02 UTC

Severity: minor

Found in version 24.5

Done: Eli Zaretskii <eliz <at> gnu.org>

Bug is archived. No further changes may be made.

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

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

View this report as an mbox folder, status mbox, maintainer mbox

Report forwarded to bug-gnu-emacs <at> gnu.org:
bug#24413; Package emacs. (Sun, 11 Sep 2016 16:54:02 GMT) Full text and rfc822 format available.
Acknowledgement sent to Drew Adams <drew.adams <at> oracle.com>:
New bug report received and forwarded. Copy sent to bug-gnu-emacs <at> gnu.org. (Sun, 11 Sep 2016 16:54:02 GMT) Full text and rfc822 format available.

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.5; doc string of `whitespace-mode' does not mention Lisp `toggle'
 arg
Date: Sun, 11 Sep 2016 09:52:45 -0700 (PDT)

In this respect, the explicit doc string provided when defining
`whitespace-mode' is _worse_ than the default doc string provided by
`define-minor-mode'.  The latter at least adds this important
information, which is missing from `C-h f whitespace-mode':

  "and toggle it if ARG is `toggle'."

This might not be the only minor mode whose doc fails to mention
`toggle' as ARG for Lisp.

See http://emacs.stackexchange.com/a/27006/105.

In GNU Emacs 24.5.1 (i686-pc-mingw32)
 of 2015-04-11 on LEG570
Windowing system distributor `Microsoft Corp.', version 6.1.7601
Configured using:
 `configure --prefix=/c/usr --host=i686-pc-mingw32'
Reply sent to Eli Zaretskii <eliz <at> gnu.org>:
You have taken responsibility. (Fri, 16 Sep 2016 09:48:02 GMT) Full text and rfc822 format available.
Notification sent to Drew Adams <drew.adams <at> oracle.com>:
bug acknowledged by developer. (Fri, 16 Sep 2016 09:48:02 GMT) Full text and rfc822 format available.

Message #10 received at 24413-done <at> debbugs.gnu.org (full text, mbox):

From: Eli Zaretskii <eliz <at> gnu.org>
To: Drew Adams <drew.adams <at> oracle.com>
Cc: 24413-done <at> debbugs.gnu.org
Subject: Re: bug#24413: 24.5;
 doc string of `whitespace-mode' does not mention Lisp `toggle' arg
Date: Fri, 16 Sep 2016 12:47:15 +0300

> Date: Sun, 11 Sep 2016 09:52:45 -0700 (PDT)
> From: Drew Adams <drew.adams <at> oracle.com>
> 
> In this respect, the explicit doc string provided when defining
> `whitespace-mode' is _worse_ than the default doc string provided by
> `define-minor-mode'.  The latter at least adds this important
> information, which is missing from `C-h f whitespace-mode':
> 
>   "and toggle it if ARG is `toggle'."

Thanks, fixed.
bug archived. Request was from Debbugs Internal Request <help-debbugs <at> gnu.org> to internal_control <at> debbugs.gnu.org. (Fri, 14 Oct 2016 11:24:03 GMT) Full text and rfc822 format available.
This bug report was last modified 8 years and 252 days ago.

Previous Next

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