From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!not-for-mail From: Drew Adams Newsgroups: gmane.emacs.bugs Subject: bug#15632: 24.3.50; doc string of `replace-match-maybe-edit' Date: Wed, 16 Oct 2013 08:48:11 -0700 (PDT) Message-ID: <7daeb745-0021-4380-a5de-1f74eed1d0c6@default> NNTP-Posting-Host: plane.gmane.org Mime-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Transfer-Encoding: quoted-printable X-Trace: ger.gmane.org 1381938565 12078 80.91.229.3 (16 Oct 2013 15:49:25 GMT) X-Complaints-To: usenet@ger.gmane.org NNTP-Posting-Date: Wed, 16 Oct 2013 15:49:25 +0000 (UTC) To: 15632@debbugs.gnu.org Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Wed Oct 16 17:49:26 2013 Return-path: Envelope-to: geb-bug-gnu-emacs@m.gmane.org Original-Received: from lists.gnu.org ([208.118.235.17]) by plane.gmane.org with esmtp (Exim 4.69) (envelope-from ) id 1VWTLi-0007cd-Bd for geb-bug-gnu-emacs@m.gmane.org; Wed, 16 Oct 2013 17:49:26 +0200 Original-Received: from localhost ([::1]:48015 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1VWTLi-0003tA-19 for geb-bug-gnu-emacs@m.gmane.org; Wed, 16 Oct 2013 11:49:26 -0400 Original-Received: from eggs.gnu.org ([2001:4830:134:3::10]:58384) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1VWTLV-0003sm-F4 for bug-gnu-emacs@gnu.org; Wed, 16 Oct 2013 11:49:23 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1VWTLL-0007i4-7g for bug-gnu-emacs@gnu.org; Wed, 16 Oct 2013 11:49:13 -0400 Original-Received: from debbugs.gnu.org ([140.186.70.43]:40414) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1VWTLL-0007hv-4G for bug-gnu-emacs@gnu.org; Wed, 16 Oct 2013 11:49:03 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.80) (envelope-from ) id 1VWTLK-0005nj-IC for bug-gnu-emacs@gnu.org; Wed, 16 Oct 2013 11:49:02 -0400 X-Loop: help-debbugs@gnu.org Resent-From: Drew Adams Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Wed, 16 Oct 2013 15:49:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: report 15632 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: X-Debbugs-Original-To: bug-gnu-emacs@gnu.org Original-Received: via spool by submit@debbugs.gnu.org id=B.138193853222282 (code B ref -1); Wed, 16 Oct 2013 15:49:02 +0000 Original-Received: (at submit) by debbugs.gnu.org; 16 Oct 2013 15:48:52 +0000 Original-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 Original-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 Original-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 Original-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 Original-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 Original-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 Original-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 Original-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 Original-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 Original-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 X-Priority: 3 X-Mailer: Oracle Beehive Extensions for Outlook 2.0.1.8 (707110) [OL 12.0.6680.5000 (x86)] 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-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.15 Precedence: list X-detected-operating-system: by eggs.gnu.org: GNU/Linux 3.x X-Received-From: 140.186.70.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-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Xref: news.gmane.org gmane.emacs.bugs:79316 Archived-At: 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'