From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!.POSTED!not-for-mail From: Stefan Monnier Newsgroups: gmane.emacs.bugs Subject: bug#10754: define-minor-mode and doc of derived mode Date: Mon, 18 Jun 2018 09:47:30 -0400 Message-ID: References: <87po12g7x4.fsf@gmail.com> <0edf0759-1044-4c6f-b70a-addebc9078f8@default> <87in6trm00.fsf@gmail.com> <83y3ffypek.fsf@gnu.org> <87fu1lv24d.fsf@gmail.com> <87d0wpurh5.fsf@gmail.com> <87bmc9uhl0.fsf@gmail.com> NNTP-Posting-Host: blaine.gmane.org Mime-Version: 1.0 Content-Type: text/plain X-Trace: blaine.gmane.org 1529329571 25366 195.159.176.226 (18 Jun 2018 13:46:11 GMT) X-Complaints-To: usenet@blaine.gmane.org NNTP-Posting-Date: Mon, 18 Jun 2018 13:46:11 +0000 (UTC) User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/27.0.50 (gnu/linux) Cc: 10754@debbugs.gnu.org To: John Shahid Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Mon Jun 18 15:46:07 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 1fUuTu-0006VC-Ry for geb-bug-gnu-emacs@m.gmane.org; Mon, 18 Jun 2018 15:46:06 +0200 Original-Received: from localhost ([::1]:34874 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1fUuW1-0002Bi-Kf for geb-bug-gnu-emacs@m.gmane.org; Mon, 18 Jun 2018 09:48:17 -0400 Original-Received: from eggs.gnu.org ([2001:4830:134:3::10]:32802) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1fUuVt-0002BP-Gq for bug-gnu-emacs@gnu.org; Mon, 18 Jun 2018 09:48:10 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1fUuVn-0004YB-7I for bug-gnu-emacs@gnu.org; Mon, 18 Jun 2018 09:48:09 -0400 Original-Received: from debbugs.gnu.org ([208.118.235.43]:46603) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1fUuVn-0004Y4-2Y for bug-gnu-emacs@gnu.org; Mon, 18 Jun 2018 09:48:03 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1fUuVm-0001tT-Ms for bug-gnu-emacs@gnu.org; Mon, 18 Jun 2018 09:48:02 -0400 X-Loop: help-debbugs@gnu.org Resent-From: Stefan Monnier Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Mon, 18 Jun 2018 13:48:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 10754 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: Original-Received: via spool by 10754-submit@debbugs.gnu.org id=B10754.15293296547242 (code B ref 10754); Mon, 18 Jun 2018 13:48:02 +0000 Original-Received: (at 10754) by debbugs.gnu.org; 18 Jun 2018 13:47:34 +0000 Original-Received: from localhost ([127.0.0.1]:54500 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1fUuVK-0001sj-Lu for submit@debbugs.gnu.org; Mon, 18 Jun 2018 09:47:34 -0400 Original-Received: from chene.dit.umontreal.ca ([132.204.246.20]:51618) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1fUuVI-0001sb-HZ for 10754@debbugs.gnu.org; Mon, 18 Jun 2018 09:47:33 -0400 Original-Received: from ceviche.home (lechon.iro.umontreal.ca [132.204.27.242]) by chene.dit.umontreal.ca (8.14.7/8.14.1) with ESMTP id w5IDm1Z9025321; Mon, 18 Jun 2018 09:48:01 -0400 Original-Received: by ceviche.home (Postfix, from userid 20848) id 70C3B6611F; Mon, 18 Jun 2018 09:47:30 -0400 (EDT) In-Reply-To: <87bmc9uhl0.fsf@gmail.com> (John Shahid's message of "Sun, 17 Jun 2018 23:19:23 +0000") X-NAI-Spam-Flag: NO X-NAI-Spam-Threshold: 5 X-NAI-Spam-Score: 0 X-NAI-Spam-Rules: 2 Rules triggered EDT_SA_DN_PASS=0, RV6310=0 X-NAI-Spam-Version: 2.3.0.9418 : core <6310> : inlines <6702> : streams <1790044> : uri <2660259> 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:147598 Archived-At: >> I think we can avoid it by looking for the presence of ARG in >> the docstring > I think this can work, but it doesn't feel very elegant or obvious from > the pov of the caller of `define-minor-mode'. What's wrong with adding > an extra keyword arg ? I think in the long term (asymptotically), the arg is unneeded. But if we add the arg, the long term will be that *all* calls will use the arg, so we'll never be able to get rid of it. I'd be OK with an arg of the form :dont-add-arg-paragraph (for those hypothetical cases where the paragraph is undesirable) but not :add-arg-paragraph. >> (or by simply always adding it, and then going through >> the various minor modes and remove the corresponding text from their >> docstrings). > I think this change needs to be backward compatible. There could be > other callers that aren't packaged with Emacs. Having the same text twice in the output of `C-h f` is fairly harmless in my opinion. We've had similar situations where `C-h v` automatically adds text like "this is only for interactive use" even tho the docstring may already say it. Stefan