From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!.POSTED!not-for-mail From: Drew Adams Newsgroups: gmane.emacs.bugs Subject: bug#33912: 27.0.50; Mention in minor-mode doc strings that the mode is a minor mode Date: Sat, 29 Dec 2018 08:13:54 -0800 (PST) Message-ID: <91d52419-1370-4a8b-9df5-6f4fd1c70dbd@default> NNTP-Posting-Host: blaine.gmane.org Mime-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Transfer-Encoding: quoted-printable X-Trace: blaine.gmane.org 1546102319 16929 195.159.176.226 (29 Dec 2018 16:51:59 GMT) X-Complaints-To: usenet@blaine.gmane.org NNTP-Posting-Date: Sat, 29 Dec 2018 16:51:59 +0000 (UTC) To: 33912@debbugs.gnu.org Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Sat Dec 29 17:51:54 2018 Return-path: Envelope-to: geb-bug-gnu-emacs@m.gmane.org Original-Received: from lists.gnu.org ([208.118.235.17]) by blaine.gmane.org with esmtp (Exim 4.84_2) (envelope-from ) id 1gdHq4-0004G4-LR for geb-bug-gnu-emacs@m.gmane.org; Sat, 29 Dec 2018 17:51:52 +0100 Original-Received: from localhost ([127.0.0.1]:40147 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1gdHsB-0005ag-Iu for geb-bug-gnu-emacs@m.gmane.org; Sat, 29 Dec 2018 11:54:03 -0500 Original-Received: from eggs.gnu.org ([208.118.235.92]:51847) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1gdHpV-0002j3-LA for bug-gnu-emacs@gnu.org; Sat, 29 Dec 2018 11:51:21 -0500 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1gdHkS-00078P-3v for bug-gnu-emacs@gnu.org; Sat, 29 Dec 2018 11:46:09 -0500 Original-Received: from debbugs.gnu.org ([208.118.235.43]:43511) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1gdHTy-0007G8-C4 for bug-gnu-emacs@gnu.org; Sat, 29 Dec 2018 11:29:03 -0500 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1gdHTy-0003ei-5a for bug-gnu-emacs@gnu.org; Sat, 29 Dec 2018 11:29:02 -0500 X-Loop: help-debbugs@gnu.org Resent-From: Drew Adams Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Sat, 29 Dec 2018 16:29:01 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: report 33912 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: X-Debbugs-Original-To: bug-gnu-emacs@gnu.org Original-Received: via spool by submit@debbugs.gnu.org id=B.154610092514025 (code B ref -1); Sat, 29 Dec 2018 16:29:01 +0000 Original-Received: (at submit) by debbugs.gnu.org; 29 Dec 2018 16:28:45 +0000 Original-Received: from localhost ([127.0.0.1]:41627 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1gdHTg-0003e9-Rk for submit@debbugs.gnu.org; Sat, 29 Dec 2018 11:28:45 -0500 Original-Received: from eggs.gnu.org ([208.118.235.92]:44998) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1gdHTc-0003dm-Ly for submit@debbugs.gnu.org; Sat, 29 Dec 2018 11:28:41 -0500 Original-Received: from lists.gnu.org ([208.118.235.17]:37614) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_256_CBC_SHA1:32) (Exim 4.71) (envelope-from ) id 1gdHTX-0006wm-Cn for submit@debbugs.gnu.org; Sat, 29 Dec 2018 11:28:35 -0500 Original-Received: from eggs.gnu.org ([208.118.235.92]:44407) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1gdHTQ-0006HU-8V for bug-gnu-emacs@gnu.org; Sat, 29 Dec 2018 11:28:34 -0500 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1gdHFY-0000I5-ML for bug-gnu-emacs@gnu.org; Sat, 29 Dec 2018 11:14:12 -0500 Original-Received: from userp2130.oracle.com ([156.151.31.86]:39670) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_256_CBC_SHA1:32) (Exim 4.71) (envelope-from ) id 1gdHFY-0000Dq-9R for bug-gnu-emacs@gnu.org; Sat, 29 Dec 2018 11:14:08 -0500 Original-Received: from pps.filterd (userp2130.oracle.com [127.0.0.1]) by userp2130.oracle.com (8.16.0.22/8.16.0.22) with SMTP id wBTGE2Y8113582 for ; Sat, 29 Dec 2018 16:14:02 GMT DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=oracle.com; h=mime-version : message-id : date : from : sender : to : subject : content-type : content-transfer-encoding; s=corp-2018-07-02; bh=vPv/xTKaDqAGjBVZ+98skMCBBrYXSdQLqU27rdEZqhA=; b=D+0UIBVgQKi4Q0AluBvP+WPmn1NcSfK+v/wYtzQ61pOqDR4UnV2iqcGqtEco0PLuizJt vLuAYNhe4wk9IseWiXVBfbGt9GGKtp1YetM+Xs8grG8g9oDAYgnK3VxK/tp1UhcMEx3P Rlg+3SB8RVijU2yUv4uVt7tzdLCfS5XuVUn+hLIATnUIKe3qa4KNoGLTaWP3qNgvQeFU 1s2e/PupFaPeE8EJICSVCU3Pa9jGrTcfND6wwc6Ahd7NO9gYuWKLAVdYu1gXdJPDnaTj C1xi9Ncedood9xIWVWz9kIk4k8FYAhZjp52ZpBGXDx6QuVQgWU3x16aI9LcPYrtw2gGS tg== Original-Received: from aserv0022.oracle.com (aserv0022.oracle.com [141.146.126.234]) by userp2130.oracle.com with ESMTP id 2pp0bth449-1 (version=TLSv1.2 cipher=ECDHE-RSA-AES256-GCM-SHA384 bits=256 verify=OK) for ; Sat, 29 Dec 2018 16:14:02 +0000 Original-Received: from aserv0121.oracle.com (aserv0121.oracle.com [141.146.126.235]) by aserv0022.oracle.com (8.14.4/8.14.4) with ESMTP id wBTGDulO013073 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-GCM-SHA384 bits=256 verify=OK) for ; Sat, 29 Dec 2018 16:13:56 GMT Original-Received: from abhmp0016.oracle.com (abhmp0016.oracle.com [141.146.116.22]) by aserv0121.oracle.com (8.14.4/8.13.8) with ESMTP id wBTGDtPM018524 for ; Sat, 29 Dec 2018 16:13:56 GMT X-Priority: 3 X-Mailer: Oracle Beehive Extensions for Outlook 2.0.1.9.1 (1003210) [OL 16.0.4783.0 (x86)] X-Proofpoint-Virus-Version: vendor=nai engine=5900 definitions=9121 signatures=668680 X-Proofpoint-Spam-Details: rule=notspam policy=default score=0 suspectscore=1 malwarescore=0 phishscore=0 bulkscore=0 spamscore=0 mlxscore=0 mlxlogscore=832 adultscore=0 classifier=spam adjust=0 reason=mlx scancount=1 engine=8.0.1-1810050000 definitions=main-1812290149 X-detected-operating-system: by eggs.gnu.org: GNU/Linux 3.x [generic] [fuzzy] X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.6.x X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] X-Received-From: 208.118.235.43 X-BeenThere: bug-gnu-emacs@gnu.org List-Id: "Bug reports for GNU Emacs, the Swiss army knife of text editors" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Original-Sender: "bug-gnu-emacs" Xref: news.gmane.org gmane.emacs.bugs:153998 Archived-At: Please consider mentioning explicitly in the doc string of all minor modes (at least those defined using `define-minor-mode') that the mode is a minor mode. I thought there was already a bug, and agreement that it should be fixed, saying that more of the full info that the doc string of `define-minor-mode' provides should also be provided in the doc string of each mode. But maybe that never happened or was agreed upon. In any case, it can help a mode's doc to have it state that the mode is a minor mode. Even more helpful would be a link to either (1) the doc of `define-minor-mode' or (2) the manual. Users are often confused about how to turn a minor mode on/off, including in their init files (i.e., using Lisp). If a mode's doc doesn't make clear whether it is a major or a minor mode then this lack adds to confusion about how to enable/disable it, because the two kinds of mode are handled very differently (and a major mode is disabled only by enabled a different one, and major modes cannot be combined). The doc string of a major usually (always?) does say that it is a major mode. It is even more important that the doc of a minor say that the mode is minor - minor modes can be disabled and combined. In GNU Emacs 27.0.50 (build 3, x86_64-w64-mingw32) of 2018-03-21 Repository revision: e70d0c9e66d7a8609450b2889869d16aeb0363b5 Windowing system distributor `Microsoft Corp.', version 10.0.16299 Configured using: `configure --without-dbus --host=3Dx86_64-w64-mingw32 --without-compress-install -C 'CFLAGS=3D-O2 -static -g3''