Clarify [string map] docs to remove char/string ambiguity. [Bug 1048005]

2 files changed, 6 insertions, 4 deletions

diff --git a/ChangeLog b/ChangeLog
index dbc31f7..1d5939a 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,5 +1,7 @@
 2004-10-25  Donal K. Fellows  <donal.k.fellows@man.ac.uk>
 
+	* doc/string.n (map): Rewrote to clarify that we don't just map
+	single characters. [Bug 1048005]
 	* doc/info.n (procs): Clarified that the pattern argument may have
 	namespace separators in it. [Bug 1047928]
 
diff --git a/doc/string.n b/doc/string.n
index ff331b4..0bfe19b 100644
--- a/doc/string.n
+++ b/doc/string.n
@@ -5,7 +5,7 @@
 '\" See the file "license.terms" for information on usage and redistribution
 '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
 '\" 
-'\" RCS: @(#) $Id: string.n,v 1.21 2004/08/24 08:59:54 dkf Exp $
+'\" RCS: @(#) $Id: string.n,v 1.22 2004/10/25 22:11:11 dkf Exp $
 '\" 
 .so man.macros
 .TH string n 8.1 Tcl "Tcl Built-In Commands"
@@ -178,9 +178,9 @@ number of bytes used to store the string.  If the object is a
 ByteArray object (such as those returned from reading a binary encoded
 channel), then this will return the actual byte length of the object.
 .TP
-\fBstring map\fR ?\fB\-nocase\fR? \fIcharMap string\fR
-Replaces characters in \fIstring\fR based on the key-value pairs in
-\fIcharMap\fR.  \fIcharMap\fR is a list of \fIkey value key value ...\fR
+\fBstring map\fR ?\fB\-nocase\fR? \fImapping string\fR
+Replaces substrings in \fIstring\fR based on the key-value pairs in
+\fImapping\fR.  \fImapping\fR is a list of \fIkey value key value ...\fR
 as in the form returned by \fBarray get\fR.  Each instance of a
 key in the string will be replaced with its corresponding value.  If
 \fB\-nocase\fR is specified, then matching is done without regard to