summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorpooryorick <com.digitalsmarties@pooryorick.com>2018-08-10 18:44:41 (GMT)
committerpooryorick <com.digitalsmarties@pooryorick.com>2018-08-10 18:44:41 (GMT)
commit18c102aa7055571d742e867b44e765ac3ed0213c (patch)
tree67bc746bd4d6afc973648e5540ad406e283583a1
parente53f3cf9c69144d698f8b7899817243cd4d8d7e5 (diff)
downloadtcl-18c102aa7055571d742e867b44e765ac3ed0213c.zip
tcl-18c102aa7055571d742e867b44e765ac3ed0213c.tar.gz
tcl-18c102aa7055571d742e867b44e765ac3ed0213c.tar.bz2
minor changes to documentation
-rw-r--r--doc/SaveResult.318
1 files changed, 9 insertions, 9 deletions
diff --git a/doc/SaveResult.3 b/doc/SaveResult.3
index 1ddc1ad..51ccb23 100644
--- a/doc/SaveResult.3
+++ b/doc/SaveResult.3
@@ -33,7 +33,7 @@ int
.SH ARGUMENTS
.AS Tcl_InterpState savedPtr
.AP Tcl_Interp *interp in
-The current interpreter.
+The interpreter for the operation.
.AP int status in
The return code for the state.
.AP Tcl_InterpState state in
@@ -65,18 +65,18 @@ deprecated. Instead use \fBTcl_SaveInterpState\fR,
\fBTcl_RestoreInterpState\fR, and \fBTcl_DiscardInterpState\fR, which are more
capable.
.PP
-\fBTcl_SaveResult\fR moves the string result and structured result of
-\fIinterp\fR to the location \fIstatePtr\fR points to and returns the
-interpreter result to its initial state. It does not save options such as
-\fB\-errorcode\fR or \fB\-errorinfo\fR.
+\fBTcl_SaveResult\fR moves the result of \fIinterp\fR to the location
+\fIstatePtr\fR points to and returns the interpreter result to its initial
+state. It does not save options such as \fB\-errorcode\fR or
+\fB\-errorinfo\fR.
.PP
\fBTcl_RestoreResult\fR clears any existing result or error in \fIinterp\fR and
-moves the string result and structured result from \fIstatePtr\fR back to
-\fIinterp\fR. \fIstatePtr\fR is then in an undefined state and cannot be used
-until passed again to \fBTcl_SaveResult\fR.
+moves the result from \fIstatePtr\fR back to \fIinterp\fR. \fIstatePtr\fR is
+then in an undefined state and must not be used until passed again to
+\fBTcl_SaveResult\fR.
.PP
\fBTcl_DiscardResult\fR releases the state stored at \fBstatePtr\fR, which is
-then in an undefined state and cannot be used until passed again to
+then in an undefined state and must not be used until passed again to
\fBTcl_SaveResult\fR.
.PP
If a saved result is not restored, \fBTcl_DiscardResult\fR must be called to