summaryrefslogtreecommitdiffstats
path: root/doc/string.n
diff options
context:
space:
mode:
authordkf <donal.k.fellows@manchester.ac.uk>2012-11-08 15:21:29 (GMT)
committerdkf <donal.k.fellows@manchester.ac.uk>2012-11-08 15:21:29 (GMT)
commit58bc28f4d96ce554e59258f7386e128da4e41022 (patch)
treed58085c9ab939943ea31fedc202f83ff7bcff0b0 /doc/string.n
parent2c8604178c0e8b9dcde646dec80f3552cb4ec37e (diff)
downloadtcl-58bc28f4d96ce554e59258f7386e128da4e41022.zip
tcl-58bc28f4d96ce554e59258f7386e128da4e41022.tar.gz
tcl-58bc28f4d96ce554e59258f7386e128da4e41022.tar.bz2
Updated the language of the documentation so that "object" refers to an OO
concept throughout, and a Tcl_Obj is called a "value" (which is what it is).
Diffstat (limited to 'doc/string.n')
-rw-r--r--doc/string.n14
1 files changed, 8 insertions, 6 deletions
diff --git a/doc/string.n b/doc/string.n
index 3eae964..6b3cc59 100644
--- a/doc/string.n
+++ b/doc/string.n
@@ -25,11 +25,13 @@ Returns a decimal string giving the number of bytes used to represent
\fIstring\fR in memory. Because UTF\-8 uses one to three bytes to
represent Unicode characters, the byte length will not be the same as
the character length in general. The cases where a script cares about
-the byte length are rare. In almost all cases, you should use the
+the byte length are rare.
+.RS
+.PP
+In almost all cases, you should use the
\fBstring length\fR operation (including determining the length of a
-Tcl ByteArray object). Refer to the \fBTcl_NumUtfChars\fR manual
+Tcl byte array value). Refer to the \fBTcl_NumUtfChars\fR manual
entry for more details on the UTF\-8 representation.
-.RS
.PP
\fICompatibility note:\fR it is likely that this subcommand will be
withdrawn in a future version of Tcl. It is better to use the
@@ -199,9 +201,9 @@ will return \fB1\fR.
.
Returns a decimal string giving the number of characters in
\fIstring\fR. Note that this is not necessarily the same as the
-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.
+number of bytes used to store the string. If the value is a
+byte array value (such as those returned from reading a binary encoded
+channel), then this will return the actual byte length of the value.
.TP
\fBstring map\fR ?\fB\-nocase\fR? \fImapping string\fR
.