Minor doc fix for string predicates.

 doc/lispref/strings.texi (Text Comparison): Mention
 equal-including-properties for when text properties of the strings
 matter for comparison.

diff --git a/doc/lispref/ChangeLog b/doc/lispref/ChangeLog
index de3b1ddb20c7a39d673b79ee243f1f53de2bd855..c2907cccf6e71a43c2460b25fc14566fac5fef84 100644 (file)
--- a/doc/lispref/ChangeLog
+++ b/doc/lispref/ChangeLog
@@ -1,3 +1,9 @@
+2014-04-24  Eli Zaretskii  <eliz@gnu.org>
+
+       * strings.texi (Text Comparison): Mention
+       equal-including-properties for when text properties of the strings
+       matter for comparison.
+
 2014-04-21  Eli Zaretskii  <eliz@gnu.org>
 
        * text.texi (Registers): Document register-read-with-preview.

diff --git a/doc/lispref/strings.texi b/doc/lispref/strings.texi
index 24218a9cf1531dfbc6eb7b5377901c23b937458b..e6b00f06f79425ffb85c0276b1f43adc3d9e0653 100644 (file)
--- a/doc/lispref/strings.texi
+++ b/doc/lispref/strings.texi
@@ -423,8 +423,10 @@ the symbol names are used.  Case is always significant, regardless of
 
 This function is equivalent to @code{equal} for comparing two strings
 (@pxref{Equality Predicates}).  In particular, the text properties of
-the two strings are ignored.  But if either argument is not a string
-or symbol, an error is signaled.
+the two strings are ignored; use @code{equal-including-properties} if
+you need to distinguish between strings that differ only in their text
+properties.  However, unlike @code{equal}, if either argument is not a
+string or symbol, @code{string=} signals an error.
 
 @example
 (string= "abc" "abc")