diff options
author | jan.nijtmans <nijtmans@users.sourceforge.net> | 2016-03-02 08:49:12 (GMT) |
---|---|---|
committer | jan.nijtmans <nijtmans@users.sourceforge.net> | 2016-03-02 08:49:12 (GMT) |
commit | 8815f9f3c32c06e9f2d1d2b8ea69e1810988c5a4 (patch) | |
tree | f29c5c0c6331b03c26871392bc54d38fff2e3727 /doc/return.n | |
parent | c761f885ddfb0bfdc09e27db3399acb1f1b65dbd (diff) | |
download | tcl-8815f9f3c32c06e9f2d1d2b8ea69e1810988c5a4.zip tcl-8815f9f3c32c06e9f2d1d2b8ea69e1810988c5a4.tar.gz tcl-8815f9f3c32c06e9f2d1d2b8ea69e1810988c5a4.tar.bz2 |
Eliminate exess spacings in many doc pages.
Diffstat (limited to 'doc/return.n')
-rw-r--r-- | doc/return.n | 12 |
1 files changed, 6 insertions, 6 deletions
diff --git a/doc/return.n b/doc/return.n index 383ed8c..ea590ea 100644 --- a/doc/return.n +++ b/doc/return.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. -'\" +'\" .TH return n 8.5 Tcl "Tcl Built-In Commands" .so man.macros .BS @@ -24,7 +24,7 @@ return \- Return from a procedure, or set return code of a script In its simplest usage, the \fBreturn\fR command is used without options in the body of a procedure to immediately return control to the caller of the procedure. If a \fIresult\fR argument is provided, its value -becomes the result of the procedure passed back to the caller. +becomes the result of the procedure passed back to the caller. If \fIresult\fR is not specified then an empty string will be returned to the caller as the result of the procedure. .PP @@ -114,7 +114,7 @@ is meant to be additional information about the error, presented as a Tcl list for further processing by programs. If no \fB\-errorcode\fR option is provided to \fBreturn\fR when the \fB\-code error\fR option is provided, Tcl will set the value -of the \fB\-errorcode\fR entry in the return options dictionary +of the \fB\-errorcode\fR entry in the return options dictionary to the default value of \fBNONE\fR. The \fB\-errorcode\fR return option will also be stored in the global variable \fBerrorCode\fR. .TP @@ -124,7 +124,7 @@ The \fB\-errorinfo\fR option receives special treatment only when the value of the \fB\-code\fR option is \fBTCL_ERROR\fR. Then \fIinfo\fR is the initial stack trace, meant to provide to a human reader additional information about the context in which the error occurred. The stack trace will -also be stored in the global variable \fBerrorInfo\fR. +also be stored in the global variable \fBerrorInfo\fR. If no \fB\-errorinfo\fR option is provided to \fBreturn\fR when the \fB\-code error\fR option is provided, Tcl will provide its own initial stack trace value in the entry for \fB\-errorinfo\fR. Tcl's @@ -198,7 +198,7 @@ their documented interpretation in loops. .PP Procedure invocation also involves evaluation of a script, the body of the procedure. Procedure invocation provides special treatment -when evaluation of the procedure body returns the return code +when evaluation of the procedure body returns the return code \fBTCL_RETURN\fR. In that circumstance, the \fB\-level\fR entry in the return options dictionary is decremented. If after decrementing, the value of the \fB\-level\fR entry is 0, then the value of @@ -231,7 +231,7 @@ procedure, interrupting the procedure body. .CS proc printOneLine {} { puts "line 1" ;# This line will be printed. - \fBreturn\fR + \fBreturn\fR puts "line 2" ;# This line will not be printed. } .CE |