GNU bug report logs -
#15632
24.3.50; doc string of `replace-match-maybe-edit'
Previous Next
Reported by: Drew Adams <drew.adams <at> oracle.com>
Date: Wed, 16 Oct 2013 15:49:02 UTC
Severity: minor
Found in version 24.3.50
Fixed in version 24.4
Done: Lars Ingebrigtsen <larsi <at> gnus.org>
Bug is archived. No further changes may be made.
To add a comment to this bug, you must first unarchive it, by sending
a message to control AT debbugs.gnu.org, with unarchive 15632 in the body.
You can then email your comments to 15632 AT debbugs.gnu.org in the normal way.
Toggle the display of automated, internal messages from the tracker.
Report forwarded
to
bug-gnu-emacs <at> gnu.org
:
bug#15632
; Package
emacs
.
(Wed, 16 Oct 2013 15:49:02 GMT)
Full text and
rfc822 format available.
Acknowledgement sent
to
Drew Adams <drew.adams <at> oracle.com>
:
New bug report received and forwarded. Copy sent to
bug-gnu-emacs <at> gnu.org
.
(Wed, 16 Oct 2013 15:49:03 GMT)
Full text and
rfc822 format available.
Message #5 received at submit <at> debbugs.gnu.org (full text, mbox):
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 <at> swipnet.se-20131009185014-vynfyw4o8p5fge54
Windowing system distributor `Microsoft Corp.', version 6.1.7601
Configured using:
`configure --enable-checking 'CFLAGS=-O0 -g3' CPPFLAGS=-DGLYPH_DEBUG=1'
Information forwarded
to
bug-gnu-emacs <at> gnu.org
:
bug#15632
; Package
emacs
.
(Sat, 08 Feb 2014 03:58:01 GMT)
Full text and
rfc822 format available.
Message #8 received at 15632 <at> debbugs.gnu.org (full text, mbox):
Drew Adams <drew.adams <at> oracle.com> 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/
bug marked as fixed in version 24.4, send any further explanations to
15632 <at> debbugs.gnu.org and Drew Adams <drew.adams <at> oracle.com>
Request was from
Lars Ingebrigtsen <larsi <at> gnus.org>
to
control <at> debbugs.gnu.org
.
(Sat, 08 Feb 2014 03:58:02 GMT)
Full text and
rfc822 format available.
bug archived.
Request was from
Debbugs Internal Request <help-debbugs <at> gnu.org>
to
internal_control <at> debbugs.gnu.org
.
(Sat, 08 Mar 2014 12:24:05 GMT)
Full text and
rfc822 format available.
This bug report was last modified 10 years and 60 days ago.
Previous Next
GNU bug tracking system
Copyright (C) 1999 Darren O. Benham,
1997,2003 nCipher Corporation Ltd,
1994-97 Ian Jackson.