From unknown Thu Jun 19 14:18:48 2025 Content-Disposition: inline Content-Transfer-Encoding: quoted-printable MIME-Version: 1.0 X-Mailer: MIME-tools 5.509 (Entity 5.509) Content-Type: text/plain; charset=utf-8 From: bug#13926 <13926@debbugs.gnu.org> To: bug#13926 <13926@debbugs.gnu.org> Subject: Status: 24.3.50; doc string of `visual-line-mode' Reply-To: bug#13926 <13926@debbugs.gnu.org> Date: Thu, 19 Jun 2025 21:18:48 +0000 retitle 13926 24.3.50; doc string of `visual-line-mode' reassign 13926 emacs submitter 13926 "Drew Adams" severity 13926 minor thanks From debbugs-submit-bounces@debbugs.gnu.org Mon Mar 11 16:20:47 2013 Received: (at submit) by debbugs.gnu.org; 11 Mar 2013 20:20:47 +0000 Received: from localhost ([127.0.0.1]:46836 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.72) (envelope-from ) id 1UF9DC-0008TK-Pl for submit@debbugs.gnu.org; Mon, 11 Mar 2013 16:20:47 -0400 Received: from eggs.gnu.org ([208.118.235.92]:55383) by debbugs.gnu.org with esmtp (Exim 4.72) (envelope-from ) id 1UF9DA-0008T8-BT for submit@debbugs.gnu.org; Mon, 11 Mar 2013 16:20:45 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1UF9C9-0003f3-4b for submit@debbugs.gnu.org; Mon, 11 Mar 2013 16:19:43 -0400 X-Spam-Checker-Version: SpamAssassin 3.3.2 (2011-06-06) on eggs.gnu.org X-Spam-Level: X-Spam-Status: No, score=-106.6 required=5.0 tests=BAYES_00, RCVD_IN_DNSWL_MED, RP_MATCHES_RCVD, UNPARSEABLE_RELAY, USER_IN_WHITELIST autolearn=unavailable version=3.3.2 Received: from lists.gnu.org ([208.118.235.17]:41778) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1UF9C9-0003ez-1R for submit@debbugs.gnu.org; Mon, 11 Mar 2013 16:19:41 -0400 Received: from eggs.gnu.org ([208.118.235.92]:38474) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1UF9C6-00059l-AW for bug-gnu-emacs@gnu.org; Mon, 11 Mar 2013 16:19:40 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1UF9C2-0003dI-Jq for bug-gnu-emacs@gnu.org; Mon, 11 Mar 2013 16:19:38 -0400 Received: from userp1040.oracle.com ([156.151.31.81]:28117) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1UF9C2-0003d7-Bk for bug-gnu-emacs@gnu.org; Mon, 11 Mar 2013 16:19:34 -0400 Received: from ucsinet22.oracle.com (ucsinet22.oracle.com [156.151.31.94]) by userp1040.oracle.com (Sentrion-MTA-4.3.1/Sentrion-MTA-4.3.1) with ESMTP id r2BKJXaO002438 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-SHA bits=256 verify=OK) for ; Mon, 11 Mar 2013 20:19:33 GMT Received: from acsmt358.oracle.com (acsmt358.oracle.com [141.146.40.158]) by ucsinet22.oracle.com (8.14.4+Sun/8.14.4) with ESMTP id r2BKJWg3011745 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-SHA bits=256 verify=NO) for ; Mon, 11 Mar 2013 20:19:32 GMT Received: from abhmt115.oracle.com (abhmt115.oracle.com [141.146.116.67]) by acsmt358.oracle.com (8.12.11.20060308/8.12.11) with ESMTP id r2BKJVOM000358 for ; Mon, 11 Mar 2013 15:19:32 -0500 Received: from dradamslap1 (/130.35.178.8) by default (Oracle Beehive Gateway v4.0) with ESMTP ; Mon, 11 Mar 2013 13:19:31 -0700 From: "Drew Adams" To: Subject: 24.3.50; doc string of `visual-line-mode' Date: Mon, 11 Mar 2013 13:19:30 -0700 Message-ID: <25665444134D45E08D468EC49539ACEA@us.oracle.com> MIME-Version: 1.0 Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7bit X-Mailer: Microsoft Office Outlook 11 Thread-Index: Ac4elbzSXp0yqPiQQLK1co3dOBgK7g== X-MimeOLE: Produced By Microsoft MimeOLE V6.00.2900.6157 X-Source-IP: ucsinet22.oracle.com [156.151.31.94] X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.4.x-2.6.x [generic] X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.6.x X-Received-From: 208.118.235.17 X-Spam-Score: -4.3 (----) X-Debbugs-Envelope-To: submit X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.13 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Sender: debbugs-submit-bounces@debbugs.gnu.org Errors-To: debbugs-submit-bounces@debbugs.gnu.org X-Spam-Score: -6.2 (------) The doc string is misleading wrt the argument when called from Lisp. With a prefix argument ARG, enable Visual Line mode if ARG is positive, and disable it otherwise. If called from Lisp, enable the mode if ARG is omitted or nil. This makes no connection between the interactive prefix arg and the arg when called from Lisp. In particular, it can also give the incorrect impression that the mode is enabled ONLY if ARG is omitted or nil. There is nothing that suggests the behavior of a non-positive or positive ARG when called from Lisp. By way of contrast, the doc string of `define-minor-mode' correctly says what the argument values do when called from Lisp: When called from Lisp, the mode command toggles the mode if the argument is `toggle', disables the mode if the argument is a non-positive integer, and enables the mode otherwise (including if the argument is omitted or nil or a positive integer). This kind of careful description should probably be added automatically to functions defined by `define-minor-mode', to prevent misleading doc wrt the argument. In GNU Emacs 24.3.50.1 (i386-mingw-nt5.1.2600) of 2013-03-04 on ODIEONE Bzr revision: 111935 yamaoka@jpl.org-20130304102733-4qy111z41qwoh2as Windowing system distributor `Microsoft Corp.', version 5.1.2600 Configured using: `configure --with-gcc (4.7) --no-opt --enable-checking --cflags -IC:/Devel/emacs/build/include --ldflags -LC:/Devel/emacs/build/lib' From debbugs-submit-bounces@debbugs.gnu.org Sat Feb 08 08:00:02 2014 Received: (at 13926) by debbugs.gnu.org; 8 Feb 2014 13:00:02 +0000 Received: from localhost ([127.0.0.1]:56668 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.80) (envelope-from ) id 1WC7Vo-00013B-9H for submit@debbugs.gnu.org; Sat, 08 Feb 2014 08:00:00 -0500 Received: from hermes.netfonds.no ([80.91.224.195]:57111) by debbugs.gnu.org with esmtp (Exim 4.80) (envelope-from ) id 1WC7Vk-000131-K0 for 13926@debbugs.gnu.org; Sat, 08 Feb 2014 07:59:57 -0500 Received: from [204.14.154.233] (helo=building.gnus.org) by hermes.netfonds.no with esmtpsa (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.72) (envelope-from ) id 1WC7VV-0002md-Fz; Sat, 08 Feb 2014 13:59:42 +0100 From: Lars Ingebrigtsen To: "Drew Adams" Subject: Re: bug#13926: 24.3.50; doc string of `visual-line-mode' References: <25665444134D45E08D468EC49539ACEA@us.oracle.com> Date: Sat, 08 Feb 2014 04:58:32 -0800 In-Reply-To: <25665444134D45E08D468EC49539ACEA@us.oracle.com> (Drew Adams's message of "Mon, 11 Mar 2013 13:19:30 -0700") Message-ID: <87fvntrcav.fsf@building.gnus.org> User-Agent: Gnus/5.13001 (Ma Gnus v0.10) Emacs/24.3.50 (gnu/linux) MIME-Version: 1.0 Content-Type: text/plain X-MailScanner-ID: 1WC7VV-0002md-Fz X-Netfonds-MailScanner: Found to be clean X-Netfonds-MailScanner-From: larsi@gnus.org MailScanner-NULL-Check: 1392469182.73716@msJie+PybpVI7FUjHhiVgg X-Spam-Status: No X-Spam-Score: 0.0 (/) X-Debbugs-Envelope-To: 13926 Cc: 13926@debbugs.gnu.org X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: 0.0 (/) "Drew Adams" writes: > The doc string is misleading wrt the argument when called from Lisp. > > With a prefix argument ARG, enable Visual Line mode if ARG is > positive, and disable it otherwise. If called from Lisp, enable > the mode if ARG is omitted or nil. > > This makes no connection between the interactive prefix arg and the arg > when called from Lisp. In particular, it can also give the incorrect > impression that the mode is enabled ONLY if ARG is omitted or nil. > There is nothing that suggests the behavior of a non-positive or > positive ARG when called from Lisp. > > By way of contrast, the doc string of `define-minor-mode' correctly says > what the argument values do when called from Lisp: > > When called from Lisp, the mode command toggles the mode if the > argument is `toggle', disables the mode if the argument is a > non-positive integer, and enables the mode otherwise (including > if the argument is omitted or nil or a positive integer). > > This kind of careful description should probably be added automatically > to functions defined by `define-minor-mode', to prevent misleading doc > wrt the argument. Everything defined by `define-minor-mode' follows this model, I think? Should `define-minor-mode' just append that to the function doc strings automatically, and then we can remove the half-assed ARG explanations from all the callers? -- (domestic pets only, the antidote for overdose, milk.) bloggy blog http://lars.ingebrigtsen.no/ From debbugs-submit-bounces@debbugs.gnu.org Fri Jan 13 12:36:05 2017 Received: (at control) by debbugs.gnu.org; 13 Jan 2017 17:36:06 +0000 Received: from localhost ([127.0.0.1]:53121 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1cS5ll-0002jM-P6 for submit@debbugs.gnu.org; Fri, 13 Jan 2017 12:36:05 -0500 Received: from eggs.gnu.org ([208.118.235.92]:40914) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1cS5lk-0002il-Do for control@debbugs.gnu.org; Fri, 13 Jan 2017 12:36:04 -0500 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1cS5le-0006cf-MY for control@debbugs.gnu.org; Fri, 13 Jan 2017 12:35:59 -0500 X-Spam-Checker-Version: SpamAssassin 3.3.2 (2011-06-06) on eggs.gnu.org X-Spam-Level: X-Spam-Status: No, score=-5.1 required=5.0 tests=BAYES_00,RP_MATCHES_RCVD autolearn=disabled version=3.3.2 Received: from fencepost.gnu.org ([2001:4830:134:3::e]:41672) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1cS5le-0006ca-KD for control@debbugs.gnu.org; Fri, 13 Jan 2017 12:35:58 -0500 Received: from rgm by fencepost.gnu.org with local (Exim 4.82) (envelope-from ) id 1cS5le-000351-Bc for control@debbugs.gnu.org; Fri, 13 Jan 2017 12:35:58 -0500 Subject: control message for bug 25434 To: X-Mailer: mail (GNU Mailutils 2.99.98) Message-Id: From: Glenn Morris Date: Fri, 13 Jan 2017 12:35:58 -0500 X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] X-Received-From: 2001:4830:134:3::e X-Spam-Score: -8.2 (--------) X-Debbugs-Envelope-To: control X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: -8.2 (--------) merge 13926 25434 From debbugs-submit-bounces@debbugs.gnu.org Fri Jan 13 12:53:31 2017 Received: (at control) by debbugs.gnu.org; 13 Jan 2017 17:53:31 +0000 Received: from localhost ([127.0.0.1]:53130 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1cS62d-0004ob-FA for submit@debbugs.gnu.org; Fri, 13 Jan 2017 12:53:31 -0500 Received: from eggs.gnu.org ([208.118.235.92]:44639) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1cS62c-0004oO-DQ for control@debbugs.gnu.org; Fri, 13 Jan 2017 12:53:30 -0500 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1cS62W-0006wL-Fp for control@debbugs.gnu.org; Fri, 13 Jan 2017 12:53:25 -0500 X-Spam-Checker-Version: SpamAssassin 3.3.2 (2011-06-06) on eggs.gnu.org X-Spam-Level: X-Spam-Status: No, score=-5.1 required=5.0 tests=BAYES_00,RP_MATCHES_RCVD autolearn=disabled version=3.3.2 Received: from fencepost.gnu.org ([2001:4830:134:3::e]:41979) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1cS62W-0006w9-D1 for control@debbugs.gnu.org; Fri, 13 Jan 2017 12:53:24 -0500 Received: from rgm by fencepost.gnu.org with local (Exim 4.82) (envelope-from ) id 1cS62W-000557-37 for control@debbugs.gnu.org; Fri, 13 Jan 2017 12:53:24 -0500 Subject: control message for bug 25434 To: X-Mailer: mail (GNU Mailutils 2.99.98) Message-Id: From: Glenn Morris Date: Fri, 13 Jan 2017 12:53:24 -0500 X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] X-Received-From: 2001:4830:134:3::e X-Spam-Score: -8.2 (--------) X-Debbugs-Envelope-To: control X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: -8.2 (--------) merge 25428 25434 From unknown Thu Jun 19 14:18:48 2025 Received: (at fakecontrol) by fakecontrolmessage; To: internal_control@debbugs.gnu.org From: Debbugs Internal Request Subject: Internal Control Message-Id: bug archived. Date: Sat, 23 Sep 2017 11:24:04 +0000 User-Agent: Fakemail v42.6.9 # This is a fake control message. # # The action: # bug archived. thanks # This fakemail brought to you by your local debbugs # administrator