From mboxrd@z Thu Jan  1 00:00:00 1970
Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail
From: Drew Adams <drew.adams@oracle.com>
Newsgroups: gmane.emacs.bugs
Subject: bug#41884: 27.0.91;
 `C-h f whitespace-mode' doesn't say that it's a minor mode
Date: Sun, 2 Aug 2020 09:27:41 -0700 (PDT)
Message-ID: <81a68df2-ac5b-47f2-bbfb-1ea37c67426f@default>
References: <2f814ee0-f472-43f6-878b-a9c9489d771e@default>
 <CADwFkmm+bEojs03A76PoLPO08CQpTCfQZgErP2gYbXYumai1sw@mail.gmail.com>
Mime-Version: 1.0
Content-Type: text/plain; charset=utf-8
Content-Transfer-Encoding: quoted-printable
Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214";
	logging-data="3502"; mail-complaints-to="usenet@ciao.gmane.io"
To: Stefan Kangas <stefankangas@gmail.com>, 41884@debbugs.gnu.org
Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Sun Aug 02 18:28:09 2020
Return-path: <bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org>
Envelope-to: geb-bug-gnu-emacs@m.gmane-mx.org
Original-Received: from lists.gnu.org ([209.51.188.17])
	by ciao.gmane.io with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256)
	(Exim 4.92)
	(envelope-from <bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org>)
	id 1k2GqH-0000oy-MI
	for geb-bug-gnu-emacs@m.gmane-mx.org; Sun, 02 Aug 2020 18:28:09 +0200
Original-Received: from localhost ([::1]:60568 helo=lists1p.gnu.org)
	by lists.gnu.org with esmtp (Exim 4.90_1)
	(envelope-from <bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org>)
	id 1k2GqG-0004ic-NA
	for geb-bug-gnu-emacs@m.gmane-mx.org; Sun, 02 Aug 2020 12:28:08 -0400
Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:53858)
 by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256)
 (Exim 4.90_1) (envelope-from <Debian-debbugs@debbugs.gnu.org>)
 id 1k2GqA-0004iS-MC
 for bug-gnu-emacs@gnu.org; Sun, 02 Aug 2020 12:28:02 -0400
Original-Received: from debbugs.gnu.org ([209.51.188.43]:59949)
 by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128)
 (Exim 4.90_1) (envelope-from <Debian-debbugs@debbugs.gnu.org>)
 id 1k2GqA-0005no-De
 for bug-gnu-emacs@gnu.org; Sun, 02 Aug 2020 12:28:02 -0400
Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2)
 (envelope-from <Debian-debbugs@debbugs.gnu.org>) id 1k2GqA-0004Lw-An
 for bug-gnu-emacs@gnu.org; Sun, 02 Aug 2020 12:28:02 -0400
X-Loop: help-debbugs@gnu.org
Resent-From: Drew Adams <drew.adams@oracle.com>
Original-Sender: "Debbugs-submit" <debbugs-submit-bounces@debbugs.gnu.org>
Resent-CC: bug-gnu-emacs@gnu.org
Resent-Date: Sun, 02 Aug 2020 16:28:02 +0000
Resent-Message-ID: <handler.41884.B41884.159638567316716@debbugs.gnu.org>
Resent-Sender: help-debbugs@gnu.org
X-GNU-PR-Message: followup 41884
X-GNU-PR-Package: emacs
Original-Received: via spool by 41884-submit@debbugs.gnu.org id=B41884.159638567316716
 (code B ref 41884); Sun, 02 Aug 2020 16:28:02 +0000
Original-Received: (at 41884) by debbugs.gnu.org; 2 Aug 2020 16:27:53 +0000
Original-Received: from localhost ([127.0.0.1]:43262 helo=debbugs.gnu.org)
 by debbugs.gnu.org with esmtp (Exim 4.84_2)
 (envelope-from <debbugs-submit-bounces@debbugs.gnu.org>)
 id 1k2Gq0-0004LY-TC
 for submit@debbugs.gnu.org; Sun, 02 Aug 2020 12:27:53 -0400
Original-Received: from userp2120.oracle.com ([156.151.31.85]:57712)
 by debbugs.gnu.org with esmtp (Exim 4.84_2)
 (envelope-from <drew.adams@oracle.com>) id 1k2Gpx-0004LJ-NB
 for 41884@debbugs.gnu.org; Sun, 02 Aug 2020 12:27:52 -0400
Original-Received: from pps.filterd (userp2120.oracle.com [127.0.0.1])
 by userp2120.oracle.com (8.16.0.42/8.16.0.42) with SMTP id 072GP33j007886;
 Sun, 2 Aug 2020 16:27:44 GMT
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=oracle.com;
 h=mime-version :
 message-id : date : from : sender : to : subject : references :
 in-reply-to : content-type : content-transfer-encoding; s=corp-2020-01-29;
 bh=zFdVH0sry8R4snwtVpIgxcg51nDApjCBw2g3+xAswT4=;
 b=b+l+LLEKnL2LIj8rBBqHlOtA91jxDL7wJ/0cdX3w173vygICAtnt0ulEt0qgIIYClOnA
 7w/TUKDij/m7qNNu2cDkYpUafpt3Dg8TYLdZCDnDryWj0PLizwRR+ybrUGj2ylOhW5EP
 bx0oejdS80q8VhSZScex2H9kosi7rvKMeSGCodMNgP+R66YVBH8SU+GQ/F0s7n/FYWGe
 o2uAng75bNVUU3Do9fqbpYnbPwA8nWOPtMAsi3VHi8GmiXEQ49In2OaHfFuVbs2+yToL
 D5LQLzeFIoLoqm7t2LYAbZItQYdDoHSrzrIfKWvdb2y4N2Z9yDpOlcxVbkAPqTEtEAZf tg== 
Original-Received: from userp3020.oracle.com (userp3020.oracle.com [156.151.31.79])
 by userp2120.oracle.com with ESMTP id 32n11mu5xr-1
 (version=TLSv1.2 cipher=ECDHE-RSA-AES256-GCM-SHA384 bits=256 verify=FAIL);
 Sun, 02 Aug 2020 16:27:43 +0000
Original-Received: from pps.filterd (userp3020.oracle.com [127.0.0.1])
 by userp3020.oracle.com (8.16.0.42/8.16.0.42) with SMTP id 072GInWd160169;
 Sun, 2 Aug 2020 16:27:43 GMT
Original-Received: from aserv0121.oracle.com (aserv0121.oracle.com [141.146.126.235])
 by userp3020.oracle.com with ESMTP id 32nj5nwt1w-1
 (version=TLSv1.2 cipher=ECDHE-RSA-AES256-GCM-SHA384 bits=256 verify=OK);
 Sun, 02 Aug 2020 16:27:43 +0000
Original-Received: from abhmp0018.oracle.com (abhmp0018.oracle.com [141.146.116.24])
 by aserv0121.oracle.com (8.14.4/8.13.8) with ESMTP id 072GRg2N022842;
 Sun, 2 Aug 2020 16:27:42 GMT
In-Reply-To: <CADwFkmm+bEojs03A76PoLPO08CQpTCfQZgErP2gYbXYumai1sw@mail.gmail.com>
X-Priority: 3
X-Mailer: Oracle Beehive Extensions for Outlook 2.0.1.9.1  (1003210) [OL
 16.0.5017.0 (x86)]
X-Proofpoint-Virus-Version: vendor=nai engine=6000 definitions=9701
 signatures=668679
X-Proofpoint-Spam-Details: rule=notspam policy=default score=0 mlxlogscore=999
 mlxscore=0 spamscore=0
 phishscore=0 suspectscore=0 adultscore=0 bulkscore=0 malwarescore=0
 classifier=spam adjust=0 reason=mlx scancount=1 engine=8.12.0-2006250000
 definitions=main-2008020127
X-Proofpoint-Virus-Version: vendor=nai engine=6000 definitions=9701
 signatures=668679
X-Proofpoint-Spam-Details: rule=notspam policy=default score=0 clxscore=1011
 priorityscore=1501
 impostorscore=0 lowpriorityscore=0 malwarescore=0 spamscore=0 mlxscore=0
 suspectscore=0 mlxlogscore=999 phishscore=0 adultscore=0 bulkscore=0
 classifier=spam adjust=0 reason=mlx scancount=1 engine=8.12.0-2006250000
 definitions=main-2008020127
X-BeenThere: debbugs-submit@debbugs.gnu.org
X-Mailman-Version: 2.1.18
Precedence: list
X-BeenThere: bug-gnu-emacs@gnu.org
List-Id: "Bug reports for GNU Emacs,
 the Swiss army knife of text editors" <bug-gnu-emacs.gnu.org>
List-Unsubscribe: <https://lists.gnu.org/mailman/options/bug-gnu-emacs>,
 <mailto:bug-gnu-emacs-request@gnu.org?subject=unsubscribe>
List-Archive: <https://lists.gnu.org/archive/html/bug-gnu-emacs>
List-Post: <mailto:bug-gnu-emacs@gnu.org>
List-Help: <mailto:bug-gnu-emacs-request@gnu.org?subject=help>
List-Subscribe: <https://lists.gnu.org/mailman/listinfo/bug-gnu-emacs>,
 <mailto:bug-gnu-emacs-request@gnu.org?subject=subscribe>
Errors-To: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org
Original-Sender: "bug-gnu-emacs"
 <bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org>
Xref: news.gmane.io gmane.emacs.bugs:183863
Archived-At: <http://permalink.gmane.org/gmane.emacs.bugs/183863>

> > The doc string for a minor mode should tell
> > you it's a minor mode.
>=20
> Should all minor modes say this?  Because there are more examples of
> modes that don't, such as:
> - display-line-numbers-mode
> - whitespace-newline-mode
>=20
> This is just from taking a quick look.

Yes, IMO they should.  Otherwise, how will
users know?  (OK, there are ways...)

Knowing a command is a minor mode is very
important to understanding its use.  It's
could even be argued that it's the most
important thing to know about it.
____

More generally, I think a failing of some
minor-mode doc strings is that they don't
tell you the basics of what the doc string
of `define-minor-mode' tells you, e.g. how
to turn the mode on/off, both interactively
and from Lisp.

This related problem has been taken care of
here and there over the years, bit by bit,
from bug reports etc.  But I think the
problem is still present here and there.

Anyway, this bug report is only about
`whitespace-mode'.  If someone wants to
fix its problem along with that of other
minor-mode commands, please do.