summaryrefslogtreecommitdiffstats
path: root/doc/SubstObj.3
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/SubstObj.3
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/SubstObj.3')
-rw-r--r--doc/SubstObj.36
1 files changed, 3 insertions, 3 deletions
diff --git a/doc/SubstObj.3 b/doc/SubstObj.3
index 786b595..d5a52c3 100644
--- a/doc/SubstObj.3
+++ b/doc/SubstObj.3
@@ -8,7 +8,7 @@
.TH Tcl_SubstObj 3 8.4 Tcl "Tcl Library Procedures"
.BS
.SH NAME
-Tcl_SubstObj \- perform substitutions on Tcl objects
+Tcl_SubstObj \- perform substitutions on Tcl values
.SH SYNOPSIS
.nf
\fB#include <tcl.h>\fR
@@ -22,7 +22,7 @@ Interpreter in which to execute Tcl scripts and lookup variables. If
an error occurs, the interpreter's result is modified to hold an error
message.
.AP Tcl_Obj *objPtr in
-A Tcl object containing the string to perform substitutions on.
+A Tcl value containing the string to perform substitutions on.
.AP int flags in
ORed combination of flag bits that specify which substitutions to
perform. The flags \fBTCL_SUBST_COMMANDS\fR,
@@ -36,7 +36,7 @@ The \fBTcl_SubstObj\fR function is used to perform substitutions on
strings in the fashion of the \fBsubst\fR command. It gets the value
of the string contained in \fIobjPtr\fR and scans it, copying
characters and performing the chosen substitutions as it goes to an
-output object which is returned as the result of the function. In the
+output value which is returned as the result of the function. In the
event of an error occurring during the execution of a command or
variable substitution, the function returns NULL and an error message
is left in \fIinterp\fR's result.