summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorEli Zaretskii <eliz@gnu.org>2014-04-24 18:11:04 +0300
committerEli Zaretskii <eliz@gnu.org>2014-04-24 18:11:04 +0300
commit402a211fd318d0aef8de6cb606e678d2ec64706d (patch)
tree00df3558f0dec0d121827c52bf0ffa994d03148e
parentbc0650fdb6476da2d0fcb563955d848479b14959 (diff)
downloademacs-402a211fd318d0aef8de6cb606e678d2ec64706d.tar.gz
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.
-rw-r--r--doc/lispref/ChangeLog6
-rw-r--r--doc/lispref/strings.texi6
2 files changed, 10 insertions, 2 deletions
diff --git a/doc/lispref/ChangeLog b/doc/lispref/ChangeLog
index de3b1ddb20c..c2907cccf6e 100644
--- 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 24218a9cf15..e6b00f06f79 100644
--- 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")