From unknown Sat Aug 16 15:51:58 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#15632 <15632@debbugs.gnu.org> To: bug#15632 <15632@debbugs.gnu.org> Subject: Status: 24.3.50; doc string of `replace-match-maybe-edit' Reply-To: bug#15632 <15632@debbugs.gnu.org> Date: Sat, 16 Aug 2025 22:51:58 +0000 retitle 15632 24.3.50; doc string of `replace-match-maybe-edit' reassign 15632 emacs submitter 15632 Drew Adams severity 15632 minor thanks From debbugs-submit-bounces@debbugs.gnu.org Wed Oct 16 11:48:52 2013 Received: (at submit) by debbugs.gnu.org; 16 Oct 2013 15:48:52 +0000 Received: from localhost ([127.0.0.1]:54433 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.80) (envelope-from ) id 1VWTL9-0005nJ-O7 for submit@debbugs.gnu.org; Wed, 16 Oct 2013 11:48:52 -0400 Received: from eggs.gnu.org ([208.118.235.92]:56522) by debbugs.gnu.org with esmtp (Exim 4.80) (envelope-from ) id 1VWTL7-0005n8-RY for submit@debbugs.gnu.org; Wed, 16 Oct 2013 11:48:50 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1VWTKs-0007Vl-Lu for submit@debbugs.gnu.org; Wed, 16 Oct 2013 11:48:44 -0400 X-Spam-Checker-Version: SpamAssassin 3.3.2 (2011-06-06) on eggs.gnu.org X-Spam-Level: X-Spam-Status: No, score=-1.9 required=5.0 tests=BAYES_00 autolearn=disabled version=3.3.2 Received: from lists.gnu.org ([208.118.235.17]:37650) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1VWTKs-0007Vg-Ix for submit@debbugs.gnu.org; Wed, 16 Oct 2013 11:48:34 -0400 Received: from eggs.gnu.org ([2001:4830:134:3::10]:58179) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1VWTKj-0003ls-UZ for bug-gnu-emacs@gnu.org; Wed, 16 Oct 2013 11:48:34 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1VWTKZ-0007OX-9x for bug-gnu-emacs@gnu.org; Wed, 16 Oct 2013 11:48:25 -0400 Received: from userp1040.oracle.com ([156.151.31.81]:28656) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1VWTKZ-0007O4-2W for bug-gnu-emacs@gnu.org; Wed, 16 Oct 2013 11:48:15 -0400 Received: from acsinet22.oracle.com (acsinet22.oracle.com [141.146.126.238]) by userp1040.oracle.com (Sentrion-MTA-4.3.1/Sentrion-MTA-4.3.1) with ESMTP id r9GFmCaD011287 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-SHA bits=256 verify=OK) for ; Wed, 16 Oct 2013 15:48:13 GMT Received: from aserz7022.oracle.com (aserz7022.oracle.com [141.146.126.231]) by acsinet22.oracle.com (8.14.4+Sun/8.14.4) with ESMTP id r9GFmBpk026349 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-SHA bits=256 verify=NO) for ; Wed, 16 Oct 2013 15:48:12 GMT Received: from abhmt105.oracle.com (abhmt105.oracle.com [141.146.116.57]) by aserz7022.oracle.com (8.14.4+Sun/8.14.4) with ESMTP id r9GFmBIf026341 for ; Wed, 16 Oct 2013 15:48:11 GMT MIME-Version: 1.0 Message-ID: <7daeb745-0021-4380-a5de-1f74eed1d0c6@default> Date: Wed, 16 Oct 2013 08:48:11 -0700 (PDT) From: Drew Adams To: bug-gnu-emacs@gnu.org Subject: 24.3.50; doc string of `replace-match-maybe-edit' X-Priority: 3 X-Mailer: Oracle Beehive Extensions for Outlook 2.0.1.8 (707110) [OL 12.0.6680.5000 (x86)] Content-Type: text/plain; charset=us-ascii Content-Transfer-Encoding: quoted-printable X-Source-IP: acsinet22.oracle.com [141.146.126.238] 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.0 (----) X-Debbugs-Envelope-To: submit 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: -4.0 (----) 1. It is not true that NEWTEXT is "just passed on". If `\?' is present then it is updated to the result of editing. It is that possibly edited result that is then passed to `replace-match'. 2. Even though the first line suggests that this function will use `replace-match' as a helper, this part of the doc string is unclear (and false - see #1): "NEWTEXT, FIXEDCASE, LITERAL are just passed on." The point of saying that an arg is "passed on" is to refer the reader to the function where it is actually used and documented. Rather than documenting here what the parameter does, we send you to the doc of another function, where the parameter is described fully. The text should say something like this: "FIXEDCASE, LITERAL are passed to `replace-match' (which see). After possibly editing it, NEWTEXT is also passed to `replace-match'. 3. The next-to-last sentence is unclear. NOEDIT is *always* "passed in". The doc should say that the return value is nil iff NOEDIT is nil or NEWTEXT was edited. In GNU Emacs 24.3.50.1 (i686-pc-mingw32) of 2013-10-09 on LEG570 Bzr revision: 114596 jan.h.d@swipnet.se-20131009185014-vynfyw4o8p5fge54 Windowing system distributor `Microsoft Corp.', version 6.1.7601 Configured using: `configure --enable-checking 'CFLAGS=3D-O0 -g3' CPPFLAGS=3D-DGLYPH_DEBUG= =3D1' From debbugs-submit-bounces@debbugs.gnu.org Fri Feb 07 22:57:24 2014 Received: (at 15632) by debbugs.gnu.org; 8 Feb 2014 03:57:24 +0000 Received: from localhost ([127.0.0.1]:55846 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.80) (envelope-from ) id 1WBz2h-0000s2-C9 for submit@debbugs.gnu.org; Fri, 07 Feb 2014 22:57:23 -0500 Received: from hermes.netfonds.no ([80.91.224.195]:60984) by debbugs.gnu.org with esmtp (Exim 4.80) (envelope-from ) id 1WBz2e-0000rt-Qu for 15632@debbugs.gnu.org; Fri, 07 Feb 2014 22:57:21 -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 1WBz2N-0004Wz-IL; Sat, 08 Feb 2014 04:57:03 +0100 From: Lars Ingebrigtsen To: Drew Adams Subject: Re: bug#15632: 24.3.50; doc string of `replace-match-maybe-edit' References: <7daeb745-0021-4380-a5de-1f74eed1d0c6@default> Date: Fri, 07 Feb 2014 19:55:55 -0800 In-Reply-To: <7daeb745-0021-4380-a5de-1f74eed1d0c6@default> (Drew Adams's message of "Wed, 16 Oct 2013 08:48:11 -0700 (PDT)") Message-ID: <8738ju8dh0.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: 1WBz2N-0004Wz-IL X-Netfonds-MailScanner: Found to be clean X-Netfonds-MailScanner-From: larsi@gnus.org MailScanner-NULL-Check: 1392436626.25987@ZfY9s+LqUbkuzatZ8GjF7g X-Spam-Status: No X-Spam-Score: 0.0 (/) X-Debbugs-Envelope-To: 15632 Cc: 15632@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: > 1. It is not true that NEWTEXT is "just passed on". If `\?' is present > then it is updated to the result of editing. It is that possibly edited > result that is then passed to `replace-match'. > > 2. Even though the first line suggests that this function will use > `replace-match' as a helper, this part of the doc string is unclear (and > false - see #1): > > "NEWTEXT, FIXEDCASE, LITERAL are just passed on." > > The point of saying that an arg is "passed on" is to refer the reader to > the function where it is actually used and documented. Rather than > documenting here what the parameter does, we send you to the doc of > another function, where the parameter is described fully. > > The text should say something like this: > > "FIXEDCASE, LITERAL are passed to `replace-match' (which see). After > possibly editing it, NEWTEXT is also passed to `replace-match'. Fixed on trunk. > 3. The next-to-last sentence is unclear. NOEDIT is *always* "passed > in". The doc should say that the return value is nil iff NOEDIT is nil > or NEWTEXT was edited. This seems to have been edited already. -- (domestic pets only, the antidote for overdose, milk.) bloggy blog http://lars.ingebrigtsen.no/ From debbugs-submit-bounces@debbugs.gnu.org Fri Feb 07 22:57:25 2014 Received: (at control) by debbugs.gnu.org; 8 Feb 2014 03:57:25 +0000 Received: from localhost ([127.0.0.1]:55848 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.80) (envelope-from ) id 1WBz2j-0000sG-EE for submit@debbugs.gnu.org; Fri, 07 Feb 2014 22:57:25 -0500 Received: from hermes.netfonds.no ([80.91.224.195]:60990) by debbugs.gnu.org with esmtp (Exim 4.80) (envelope-from ) id 1WBz2h-0000s1-1G for control@debbugs.gnu.org; Fri, 07 Feb 2014 22:57:23 -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 1WBz2S-0004X8-Lu for control@debbugs.gnu.org; Sat, 08 Feb 2014 04:57:09 +0100 Date: Fri, 07 Feb 2014 19:56:00 -0800 Message-Id: <871tze8dgv.fsf@building.gnus.org> To: control@debbugs.gnu.org From: Lars Ingebrigtsen Subject: control message for bug #15632 X-MailScanner-ID: 1WBz2S-0004X8-Lu X-Netfonds-MailScanner: Found to be clean X-Netfonds-MailScanner-From: larsi@gnus.org MailScanner-NULL-Check: 1392436629.61615@hJPx3K7xauVxf1AukPi9Kg X-Spam-Status: No X-Spam-Score: 0.0 (/) X-Debbugs-Envelope-To: control 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 (/) close 15632 24.4 From unknown Sat Aug 16 15:51:58 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, 08 Mar 2014 12:24:05 +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