From: Mattias Engdegård <mattiase@acm.org>
Date: Sun, 27 Sep 2020 12:24:36 +0000 (+0200)
Subject: Improve accuracy in string-replace description (bug#43598)
X-Git-Tag: emacs-28.0.90~5854
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=583cb264ad386a3767a05233f0e50b788bcf31ac;p=emacs.git

Improve accuracy in string-replace description (bug#43598)

* doc/lispref/searching.texi (Search and Replace): More careful
description; string-replace does not necessarily return a copy.
---

diff --git a/doc/lispref/searching.texi b/doc/lispref/searching.texi
index 451283b4aa5..b4fec6d1fd6 100644
--- a/doc/lispref/searching.texi
+++ b/doc/lispref/searching.texi
@@ -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},