From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Phil Sainty Newsgroups: gmane.emacs.bugs Subject: bug#49843: 28.0.50; Error in docstring after using define-globalized-minor-mode Date: Tue, 03 Aug 2021 20:37:50 +1200 Message-ID: <70a6133fb48569d5bcc1a1bf191ce582@webmail.orcon.net.nz> References: Mime-Version: 1.0 Content-Type: text/plain; charset=US-ASCII; format=flowed Content-Transfer-Encoding: 7bit Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="21431"; mail-complaints-to="usenet@ciao.gmane.io" User-Agent: Orcon Webmail Cc: 49843@debbugs.gnu.org To: dalanicolai@gmail.com Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Tue Aug 03 10:38:19 2021 Return-path: 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 ) id 1mApwI-0005TW-VR for geb-bug-gnu-emacs@m.gmane-mx.org; Tue, 03 Aug 2021 10:38:18 +0200 Original-Received: from localhost ([::1]:53916 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1mApwH-0000wH-Pj for geb-bug-gnu-emacs@m.gmane-mx.org; Tue, 03 Aug 2021 04:38:17 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:41570) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1mApw4-0000uq-Fb for bug-gnu-emacs@gnu.org; Tue, 03 Aug 2021 04:38:06 -0400 Original-Received: from debbugs.gnu.org ([209.51.188.43]:56516) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1mApw2-00061o-LH for bug-gnu-emacs@gnu.org; Tue, 03 Aug 2021 04:38:02 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1mApw2-0002F1-HV for bug-gnu-emacs@gnu.org; Tue, 03 Aug 2021 04:38:02 -0400 X-Loop: help-debbugs@gnu.org Resent-From: Phil Sainty Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Tue, 03 Aug 2021 08:38:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 49843 X-GNU-PR-Package: emacs Original-Received: via spool by 49843-submit@debbugs.gnu.org id=B49843.16279798758603 (code B ref 49843); Tue, 03 Aug 2021 08:38:02 +0000 Original-Received: (at 49843) by debbugs.gnu.org; 3 Aug 2021 08:37:55 +0000 Original-Received: from localhost ([127.0.0.1]:39829 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1mApvv-0002Eh-9f for submit@debbugs.gnu.org; Tue, 03 Aug 2021 04:37:55 -0400 Original-Received: from smtp-4.orcon.net.nz ([60.234.4.59]:48153) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1mApvt-0002EY-6P for 49843@debbugs.gnu.org; Tue, 03 Aug 2021 04:37:54 -0400 Original-Received: from [10.253.37.70] (port=52584 helo=webmail.orcon.net.nz) by smtp-4.orcon.net.nz with esmtpa (Exim 4.90_1) (envelope-from ) id 1mApvq-00032t-F3; Tue, 03 Aug 2021 20:37:50 +1200 Original-Received: from ip-116-251-162-85.kinect.net.nz ([116.251.162.85]) via [10.253.37.253] by webmail.orcon.net.nz with HTTP (HTTP/1.1 POST); Tue, 03 Aug 2021 20:37:50 +1200 In-Reply-To: X-Sender: psainty@orcon.net.nz X-GeoIP: -- X-Spam_score: -2.9 X-Spam_score_int: -28 X-Spam_bar: -- 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" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Original-Sender: "bug-gnu-emacs" Xref: news.gmane.io gmane.emacs.bugs:211091 Archived-At: On 2021-08-03 16:51, dalanicolai@gmail.com wrote: > It looks like the docstring could just copy the explanation about > behavior when calling from lisp from the `define-minor-mode' > docstring. I would use the more succinct explanation that `define-minor-mode' generates (by default) for the docstring of the mode being defined. E.g.: "If called interactively, enable Eldoc mode if ARG is positive, and disable it if ARG is zero or negative. If called from Lisp, also enable the mode if ARG is omitted or nil, and toggle it if ARG is `toggle'; disable the mode otherwise." This comes from the format variable `easy-mmode--arg-docstring'. > (I am not sure if the `define-globalized-minor-mode' macro > adds any logic for the behavior for (de)activating the global > mode. `define-globalized-minor-mode' uses `define-minor-mode' to define the global mode, so there's no unusual behaviour. > I think it only adds logic for the behavior i.c.w. its non-global > mode, for which the explanation is not clear to me also b.t.w., but > I am still trying to track down how that behaves exactly). Which aspects are you unsure of?