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

Previous Next

Full log

View this message in rfc822 format

From: help-debbugs <at> gnu.org (GNU bug Tracking System)
To: Eli Zaretskii <eliz <at> gnu.org>
Cc: tracker <at> debbugs.gnu.org
Subject: bug#24413: closed (24.5; doc string of `whitespace-mode' does not
 mention Lisp `toggle' arg)
Date: Fri, 16 Sep 2016 09:48:02 +0000

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

Your message dated Fri, 16 Sep 2016 12:47:15 +0300
with message-id <837fac5g7w.fsf <at> gnu.org>
and subject line Re: bug#24413: 24.5; doc string of `whitespace-mode' does not mention Lisp `toggle' arg
has caused the debbugs.gnu.org bug report #24413,
regarding 24.5; doc string of `whitespace-mode' does not mention Lisp `toggle' arg
to be marked as done.

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


-- 
24413: http://debbugs.gnu.org/cgi/bugreport.cgi?bug=24413
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.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'

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

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.

Previous Next

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