From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!.POSTED!not-for-mail From: John Shahid Newsgroups: gmane.emacs.bugs Subject: bug#10754: define-minor-mode and doc of derived mode Date: Wed, 20 Jun 2018 19:33:24 +0000 Message-ID: <87efh1xngb.fsf@gmail.com> 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 1529523131 18579 195.159.176.226 (20 Jun 2018 19:32:11 GMT) X-Complaints-To: usenet@blaine.gmane.org NNTP-Posting-Date: Wed, 20 Jun 2018 19:32:11 +0000 (UTC) User-Agent: mu4e 1.1.0; emacs 27.0.50 Cc: 10754@debbugs.gnu.org To: Stefan Monnier Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Wed Jun 20 21:32: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 1fVipq-0004iB-Pz for geb-bug-gnu-emacs@m.gmane.org; Wed, 20 Jun 2018 21:32:07 +0200 Original-Received: from localhost ([::1]:51469 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1fVirx-00081m-GR for geb-bug-gnu-emacs@m.gmane.org; Wed, 20 Jun 2018 15:34:17 -0400 Original-Received: from eggs.gnu.org ([2001:4830:134:3::10]:46123) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1fVirn-00080P-A8 for bug-gnu-emacs@gnu.org; Wed, 20 Jun 2018 15:34:08 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1fViri-0006AC-DU for bug-gnu-emacs@gnu.org; Wed, 20 Jun 2018 15:34:07 -0400 Original-Received: from debbugs.gnu.org ([208.118.235.43]:50065) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1fViri-0006A5-9G for bug-gnu-emacs@gnu.org; Wed, 20 Jun 2018 15:34:02 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1fVirh-0008L5-TT for bug-gnu-emacs@gnu.org; Wed, 20 Jun 2018 15:34:01 -0400 X-Loop: help-debbugs@gnu.org Resent-From: John Shahid Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Wed, 20 Jun 2018 19:34:01 +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.152952321732024 (code B ref 10754); Wed, 20 Jun 2018 19:34:01 +0000 Original-Received: (at 10754) by debbugs.gnu.org; 20 Jun 2018 19:33:37 +0000 Original-Received: from localhost ([127.0.0.1]:57962 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1fVirI-0008KS-RD for submit@debbugs.gnu.org; Wed, 20 Jun 2018 15:33:37 -0400 Original-Received: from mail-qk0-f172.google.com ([209.85.220.172]:35810) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1fVirF-0008KD-2o for 10754@debbugs.gnu.org; Wed, 20 Jun 2018 15:33:33 -0400 Original-Received: by mail-qk0-f172.google.com with SMTP id d130-v6so441567qkc.2 for <10754@debbugs.gnu.org>; Wed, 20 Jun 2018 12:33:33 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=references:user-agent:from:to:cc:subject:in-reply-to:date :message-id:mime-version; bh=2wSE+1NNp1lsJFuwVtfbSi23cBUH8YQ2tjlxUv2bxL4=; b=SxHTPWHu/KJgOFgSoW7kSNz3Tkkf8AdaKcI5rCoM04mWaDiRS5yETmx8e6COh+jipN b5AxQUhENDDL027my2Ive8EX1DZz6EFH/dTKMjYbw/4yDgQpyvY8HCqAepJSC91Dl2w1 Ay0YkQDvwMYRj51Jy4J0q+OGckFt1dhEZgMBuVdPFI2F96866+f6yU+fxHrkMToNRdIM M9R0ThAMmsRn07st76AkCV4nh1EAbPAGsFofnhiPUT9DpYxKlR5BO5FCAAP3YABF4at0 OOccn1mGegF0bZ3urL3EECjOFrtVAJHQApfEe/7qn//akZFTawJ8M4SBMOvGAxjPcSIm HfRQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:references:user-agent:from:to:cc:subject :in-reply-to:date:message-id:mime-version; bh=2wSE+1NNp1lsJFuwVtfbSi23cBUH8YQ2tjlxUv2bxL4=; b=W5ugly2S0SiT05xODs56T5Xm7nIJdt28JeFsS8FOjRmryKMCrNu/r3nGb04+k94Egn GtdPG44RVhQDghVP5GfjP1aUMz4eU5qPgZGr19kbo1t6CZkxWmC9OGY5mDhNWbkEIVoK hUHkX4QNkNLRkgzQK5NUySTfn2RamIb6c/OCTR7U9bcToD36+AeXiGoEYEQsJNVqEgw7 zDPsndh9dD2lTrP7vyZGz63rOz7GIES14NzGm1jSeWUi+YS5v2m+QhobtNyJ2tcoYZDB dXE1F6UvsaiXdLZw58yil5TtoZZ5ZiysKSprqnZDQYfoWBmILtUh6tBZcZdX3tx/da4V 7hew== X-Gm-Message-State: APt69E1hd4XgQnTPfevthlQ9pgHgYQKRxmeeGgu/GoS8NR7ov+nIosGo jsD5xZEAAjKEu3MAh523ru0= X-Google-Smtp-Source: ADUXVKLGo9xSBi4kAJvrmdQgECtTfD3AQ3v8+m0rW0I0zVyhtaHVbnY+OSOUUIslnfnHirLkMtNGzQ== X-Received: by 2002:a37:82c7:: with SMTP id e190-v6mr18455327qkd.313.1529523207501; Wed, 20 Jun 2018 12:33:27 -0700 (PDT) Original-Received: from 707bcc0f844c (mobile-166-171-184-229.mycingular.net. [166.171.184.229]) by smtp.gmail.com with ESMTPSA id a1-v6sm2640917qte.73.2018.06.20.12.33.25 (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Wed, 20 Jun 2018 12:33:26 -0700 (PDT) In-reply-to: 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:147668 Archived-At: Stefan Monnier writes: >>> 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'm worried about minor modes that don't even mention the argument. Not sure if that should be a concern since they should be documenting the ARG in the first place. I can provide examples, but the Emacs codebase has a few of those. > > 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. Sounds good. I will make this change and reply with a patch. > >>> (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