summaryrefslogtreecommitdiff
path: root/doc/lispref/strings.texi
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 /doc/lispref/strings.texi
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.
Diffstat (limited to 'doc/lispref/strings.texi')
-rw-r--r--doc/lispref/strings.texi6
1 files changed, 4 insertions, 2 deletions
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")