From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!.POSTED!not-for-mail From: Eli Zaretskii Newsgroups: gmane.emacs.bugs Subject: bug#10754: define-minor-mode and doc of derived mode Date: Sat, 30 Jun 2018 10:55:30 +0300 Message-ID: <83wougn1xp.fsf@gnu.org> References: <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> <87efh1xngb.fsf@gmail.com> <87vaa3zzsu.fsf@gmail.com> <87tvpnzzjr.fsf@gmail.com> <87d0w9yae0.fsf@gmail.com> <87bmbty798.fsf@gmail.com> <87a7rdy4o5.fsf@gmail.com> NNTP-Posting-Host: blaine.gmane.org X-Trace: blaine.gmane.org 1530345247 11860 195.159.176.226 (30 Jun 2018 07:54:07 GMT) X-Complaints-To: usenet@blaine.gmane.org NNTP-Posting-Date: Sat, 30 Jun 2018 07:54:07 +0000 (UTC) Cc: npostavs@gmail.com, 10754@debbugs.gnu.org, monnier@iro.umontreal.ca To: John Shahid Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Sat Jun 30 09:54:03 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 1fZAhm-0002zV-R7 for geb-bug-gnu-emacs@m.gmane.org; Sat, 30 Jun 2018 09:54:02 +0200 Original-Received: from localhost ([::1]:46014 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1fZAju-0004Au-47 for geb-bug-gnu-emacs@m.gmane.org; Sat, 30 Jun 2018 03:56:14 -0400 Original-Received: from eggs.gnu.org ([2001:4830:134:3::10]:51805) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1fZAjl-0004A5-MS for bug-gnu-emacs@gnu.org; Sat, 30 Jun 2018 03:56:06 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1fZAji-0000VD-LE for bug-gnu-emacs@gnu.org; Sat, 30 Jun 2018 03:56:05 -0400 Original-Received: from debbugs.gnu.org ([208.118.235.43]:60637) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1fZAji-0000Ul-Gg for bug-gnu-emacs@gnu.org; Sat, 30 Jun 2018 03:56:02 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1fZAji-0006wy-A5 for bug-gnu-emacs@gnu.org; Sat, 30 Jun 2018 03:56:02 -0400 X-Loop: help-debbugs@gnu.org Resent-From: Eli Zaretskii Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Sat, 30 Jun 2018 07:56: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.153034533126659 (code B ref 10754); Sat, 30 Jun 2018 07:56:02 +0000 Original-Received: (at 10754) by debbugs.gnu.org; 30 Jun 2018 07:55:31 +0000 Original-Received: from localhost ([127.0.0.1]:40299 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1fZAjD-0006vu-Ca for submit@debbugs.gnu.org; Sat, 30 Jun 2018 03:55:31 -0400 Original-Received: from eggs.gnu.org ([208.118.235.92]:60749) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1fZAjB-0006va-K0 for 10754@debbugs.gnu.org; Sat, 30 Jun 2018 03:55:29 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1fZAj3-0007oC-Ev for 10754@debbugs.gnu.org; Sat, 30 Jun 2018 03:55:24 -0400 Original-Received: from fencepost.gnu.org ([2001:4830:134:3::e]:57844) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1fZAj3-0007o8-AO; Sat, 30 Jun 2018 03:55:21 -0400 Original-Received: from [176.228.60.248] (port=2496 helo=home-c4e4a596f7) by fencepost.gnu.org with esmtpsa (TLS1.2:RSA_AES_256_CBC_SHA1:256) (Exim 4.82) (envelope-from ) id 1fZAj2-0004ol-JS; Sat, 30 Jun 2018 03:55:21 -0400 In-reply-to: <87a7rdy4o5.fsf@gmail.com> (message from John Shahid on Fri, 29 Jun 2018 15:48:42 +0000) X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] 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:147990 Archived-At: > From: John Shahid > Date: Fri, 29 Jun 2018 15:48:42 +0000 > Cc: Stefan Monnier , 10754@debbugs.gnu.org I have a few minor nits: > From: John Shahid > Date: Tue, 5 Jun 2018 19:56:12 -0400 > Subject: [PATCH] optionally include argument description in minor mode DOC > > * easy-mmode.el (define-minor-mode): Add a parapgraph to the mode's > docstring documenting the mode ARG usage if the supplied docstring > didn't contain the word "ARG". Please mention the bug number in the log message. > removed argument documetation from all minor modes. ^^^^^^^^^^^^ Typo. Also, this should be a full sentence, starting with a capital letter. > +(defconst easy-mmode-arg-docstring > + " > + > +If called interactively, enable %s if ARG is positive, and > +disable it otherwise. If called from Lisp, enable the mode if > +ARG is omitted or nil, and toggle it if ARG is `toggle'. Disable > +the mode otherwise") I prefer this text (which also fixes a problem with only one space between sentences): If called interactively, enable %s 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. > -documenting what its argument does. > +documenting what its argument does. If the word \"ARG\" does not ^ Two spaces between sentences, please. Thanks.