]> git.eshelyaron.com Git - emacs.git/commitdiff
Improve accuracy in string-replace description (bug#43598)
authorMattias Engdegård <mattiase@acm.org>
Sun, 27 Sep 2020 12:24:36 +0000 (14:24 +0200)
committerMattias Engdegård <mattiase@acm.org>
Sun, 27 Sep 2020 12:24:36 +0000 (14:24 +0200)
* doc/lispref/searching.texi (Search and Replace): More careful
description; string-replace does not necessarily return a copy.

doc/lispref/searching.texi

index 451283b4aa515dc386b5115486ad8b0c5a352a0a..b4fec6d1fd689e1469a7c841f75f67f5a9eb1c7c 100644 (file)
@@ -2567,8 +2567,10 @@ of matching @var{regexp} against a substring of @var{string}.
 @end defun
 
 @defun string-replace fromstring tostring instring
-This function copies @var{instring} and replaces any occurrences of
-@var{fromstring} with @var{tostring}.
+This function returns a string equal to @var{instring} where any
+occurrences of @var{fromstring} have been replaced with
+@var{tostring}.  It may return one of its arguments.
+Case is significant, and text properties are ignored.
 @end defun
 
   If you want to write a command along the lines of @code{query-replace},