--- Begin Message ---
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'
--- End Message ---
--- Begin Message ---
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 <address@hidden>
> Cc: address@hidden
>
> 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.
--- End Message ---