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.

Full log

View this message in rfc822 format

From: Drew Adams <drew.adams <at> oracle.com>
To: 24413 <at> debbugs.gnu.org
Subject: bug#24413: 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'
This bug report was last modified 8 years and 311 days ago.

Previous Next

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