From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!not-for-mail From: Lars Ingebrigtsen Newsgroups: gmane.emacs.bugs Subject: bug#20462: 25.0.50; A minor mode's doc string should say it is [local/global] a minor mode Date: Sat, 30 Apr 2016 21:03:32 +0200 Message-ID: <87shy2dim3.fsf@gnus.org> References: <38bd87fc-e9d5-43c1-9687-e66faf993c7e@default> NNTP-Posting-Host: plane.gmane.org Mime-Version: 1.0 Content-Type: text/plain X-Trace: ger.gmane.org 1462043085 9235 80.91.229.3 (30 Apr 2016 19:04:45 GMT) X-Complaints-To: usenet@ger.gmane.org NNTP-Posting-Date: Sat, 30 Apr 2016 19:04:45 +0000 (UTC) Cc: 20462@debbugs.gnu.org To: Drew Adams Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Sat Apr 30 21:04:29 2016 Return-path: Envelope-to: geb-bug-gnu-emacs@m.gmane.org Original-Received: from lists.gnu.org ([208.118.235.17]) by plane.gmane.org with esmtp (Exim 4.69) (envelope-from ) id 1awaBp-0000h4-De for geb-bug-gnu-emacs@m.gmane.org; Sat, 30 Apr 2016 21:04:29 +0200 Original-Received: from localhost ([::1]:59358 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1awaBl-0000A1-6B for geb-bug-gnu-emacs@m.gmane.org; Sat, 30 Apr 2016 15:04:25 -0400 Original-Received: from eggs.gnu.org ([2001:4830:134:3::10]:49414) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1awaBc-0008PH-RA for bug-gnu-emacs@gnu.org; Sat, 30 Apr 2016 15:04:23 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1awaBR-0007PK-4e for bug-gnu-emacs@gnu.org; Sat, 30 Apr 2016 15:04:11 -0400 Original-Received: from debbugs.gnu.org ([208.118.235.43]:46076) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1awaBR-0007Op-1X for bug-gnu-emacs@gnu.org; Sat, 30 Apr 2016 15:04:05 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1awaBN-0005ed-Ju for bug-gnu-emacs@gnu.org; Sat, 30 Apr 2016 15:04:01 -0400 X-Loop: help-debbugs@gnu.org Resent-From: Lars Ingebrigtsen Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Sat, 30 Apr 2016 19:04:01 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 20462 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: Original-Received: via spool by 20462-submit@debbugs.gnu.org id=B20462.146204301721706 (code B ref 20462); Sat, 30 Apr 2016 19:04:01 +0000 Original-Received: (at 20462) by debbugs.gnu.org; 30 Apr 2016 19:03:37 +0000 Original-Received: from localhost ([127.0.0.1]:58413 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1awaAz-0005e1-3K for submit@debbugs.gnu.org; Sat, 30 Apr 2016 15:03:37 -0400 Original-Received: from hermes.netfonds.no ([80.91.224.195]:59688) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1awaAx-0005du-9w for 20462@debbugs.gnu.org; Sat, 30 Apr 2016 15:03:35 -0400 Original-Received: from cm-84.215.1.64.getinternet.no ([84.215.1.64] helo=mouse) by hermes.netfonds.no with esmtpsa (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.84_2) (envelope-from ) id 1awaAu-0005j5-Qp; Sat, 30 Apr 2016 21:03:34 +0200 In-Reply-To: <38bd87fc-e9d5-43c1-9687-e66faf993c7e@default> (Drew Adams's message of "Wed, 29 Apr 2015 10:29:46 -0700 (PDT)") User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/25.1.50 (gnu/linux) 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:117428 Archived-At: Drew Adams writes: > A minor mode created conventionally, i.e., using `define-minor-mode' or > `define-globalized-minor-mode', should automatically have its doc string > say explicitly that it is a minor mode and whether it is local or > global. > > That helps users know what to expect, because all such minor modes have > some things in common, which are well documented. Yeah, I kinda think that `define-minor-mode' should include the toggle verbiage by default at the start of all doc strings, even if there is a doc string given. That would mean going through all the usages in the tree and remove the leading incantations, but that's no big deal. We could have a keyword :no-introduction t for the few modes that really don't want the standard verbiage at the start. -- (domestic pets only, the antidote for overdose, milk.) bloggy blog: http://lars.ingebrigtsen.no