* replace.el (replace-match-maybe-edit): Doc clarification.

Fixes: debbugs:15632

diff --git a/lisp/ChangeLog b/lisp/ChangeLog
index fe5e2914ee16c894d18842b8a135dd5462e0a5ac..c36096174679446003aa770f9f177caa8ea4918c 100644 (file)
--- a/lisp/ChangeLog
+++ b/lisp/ChangeLog
@@ -1,5 +1,8 @@
 2014-02-08  Lars Ingebrigtsen  <larsi@gnus.org>
 
+       * replace.el (replace-match-maybe-edit): Doc clarification
+       (bug#15632).
+
        * subr.el (add-to-list): Refill the paragraphs (bug#15791).
 
        * macros.el (insert-kbd-macro): Doc fix (bug#16025).

diff --git a/lisp/replace.el b/lisp/replace.el
index cce431f024835b69fec54d73d4c61b2cfa20a027..945316f586dacac34907455f5e4a6bf2ce298ee8 100644 (file)
--- a/lisp/replace.el
+++ b/lisp/replace.el
@@ -1891,9 +1891,11 @@ but coerced to the correct value of INTEGERS."
 
 (defun replace-match-maybe-edit (newtext fixedcase literal noedit match-data backward)
   "Make a replacement with `replace-match', editing `\\?'.
-NEWTEXT, FIXEDCASE, LITERAL are just passed on.  If NOEDIT is true, no
-check for `\\?' is made to save time.  MATCH-DATA is used for the
-replacement.  In case editing is done, it is changed to use markers.
+FIXEDCASE, LITERAL are passed to `replace-match' (which see).
+After possibly editing it (if `\\?' is present), NEWTEXT is also
+passed to `replace-match'.  If NOEDIT is true, no check for `\\?'
+is made (to save time).  MATCH-DATA is used for the replacement.
+In case editing is done, it is changed to use markers.
 
 The return value is non-nil if there has been no `\\?' or NOEDIT was
 passed in.  If LITERAL is set, no checking is done, anyway."