GNU bug report logs - #25428
25.1; Incorrect doc string for `delete-selection-mode'

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#25428: closed (25.1; Incorrect doc string for `delete-selection-mode')
Date: Sat, 26 Aug 2017 09:04:03 +0000

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

Your message dated Sat, 26 Aug 2017 12:03:20 +0300
with message-id <83tw0u66qv.fsf <at> gnu.org>
and subject line Re: bug#25428: 25.1; Incorrect doc string for `delete-selection-mode'
has caused the debbugs.gnu.org bug report #25428,
regarding 25.1; Incorrect doc string for `delete-selection-mode'
to be marked as done.

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


-- 
25428: http://debbugs.gnu.org/cgi/bugreport.cgi?bug=25428
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: 25.1; Incorrect doc string for `delete-selection-mode'
Date: Thu, 12 Jan 2017 08:24:39 -0800 (PST)

The doc string says this:

 If called from Lisp, enable the mode if ARG is omitted or nil.

That is completely wrong.  This is an ordinary minor mode, defined using
`define-minor-mode', whose doc string 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).

E.g., `(delete-selection-mode t)' ENABLES the mode, even though the
`delete-selection-mode' doc string says that it DISABLES it.


In GNU Emacs 25.1.1 (x86_64-w64-mingw32)
 of 2016-09-17 built on LAPHROAIG
Windowing system distributor 'Microsoft Corp.', version 6.1.7601
Configured using:
 'configure --without-dbus --without-compress-install CFLAGS=-static'

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

From: Eli Zaretskii <eliz <at> gnu.org>
To: Drew Adams <drew.adams <at> oracle.com>
Cc: 25428-done <at> debbugs.gnu.org, nljlistbox2 <at> gmail.com
Subject: Re: bug#25428: 25.1; Incorrect doc string for `delete-selection-mode'
Date: Sat, 26 Aug 2017 12:03:20 +0300

> Date: Wed, 16 Aug 2017 20:25:31 -0700 (PDT)
> From: Drew Adams <drew.adams <at> oracle.com>
> Cc: 25428 <at> debbugs.gnu.org
> 
> Let's just say that the doc string is incomplete and can easily
> mislead.
> 
> If it says anything about interactive behavior (and it should)
> then it should say just what the description of `define-minor-mode'
> says for minor modes.
> 
> If it says anything about the behavior when called from
> Lisp (and it should) then it should say just what the d-m-m
> description says. This (i.e., _all_ of the d-m-m description)
> is missing from the d-s-m doc string:
> 
> * `toggle' toggles
> * non-positive integer disables
> * anything else enables

Thanks, I fixed the doc string to include the missing information.

Previous Next

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