summaryrefslogtreecommitdiffstats
path: root/doc/lset.n
diff options
context:
space:
mode:
authordkf <donal.k.fellows@manchester.ac.uk>2003-01-23 14:18:31 (GMT)
committerdkf <donal.k.fellows@manchester.ac.uk>2003-01-23 14:18:31 (GMT)
commitffc4888f61c1b387a9b1263b73a538878e57a672 (patch)
treef153cf234f0f7912441c4961d7eb5e0f985d7aaa /doc/lset.n
parentb0b05ec0d057cfb91a39b0dc5ddb9311777784f5 (diff)
downloadtcl-ffc4888f61c1b387a9b1263b73a538878e57a672.zip
tcl-ffc4888f61c1b387a9b1263b73a538878e57a672.tar.gz
tcl-ffc4888f61c1b387a9b1263b73a538878e57a672.tar.bz2
* doc/lset.n: Fixed fault in return values from lset in
documentation examples [SF Bug #658463] and tidied up a bit at the same time.
Diffstat (limited to 'doc/lset.n')
-rwxr-xr-xdoc/lset.n32
1 files changed, 17 insertions, 15 deletions
diff --git a/doc/lset.n b/doc/lset.n
index fb61014..1e7c725 100755
--- a/doc/lset.n
+++ b/doc/lset.n
@@ -4,7 +4,7 @@
'\" See the file "license.terms" for information on usage and redistribution
'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
'\"
-'\" RCS: @(#) $Id: lset.n,v 1.5 2002/09/24 08:55:40 dkf Exp $
+'\" RCS: @(#) $Id: lset.n,v 1.6 2003/01/23 14:18:33 dkf Exp $
'\"
.so man.macros
.TH lset n 8.4 Tcl "Tcl Built-In Commands"
@@ -17,13 +17,13 @@ lset \- Change an element in a list
.BE
.SH DESCRIPTION
.PP
-The \fBlset\fP command accepts a parameter, \fIvarName\fP, which
+The \fBlset\fR command accepts a parameter, \fIvarName\fR, which
it interprets as the name of a variable containing a Tcl list.
-It also accepts zero or more \fIindices\fP into
+It also accepts zero or more \fIindices\fR into
the list. The indices may be presented either consecutively on the
command line, or grouped in a
Tcl list and presented as a single argument.
-Finally, it accepts a new value for an element of \fIvarName\fP.
+Finally, it accepts a new value for an element of \fIvarName\fR.
.PP
If no indices are presented, the command takes the form:
.CS
@@ -33,8 +33,8 @@ or
.CS
lset varName {} newValue
.CE
-In this case, \fInewValue\fP replaces the old value of the variable
-\fIvarName\fP.
+In this case, \fInewValue\fR replaces the old value of the variable
+\fIvarName\fR.
.PP
When presented with a single index, the \fBlset\fR command
treats the content of the \fIvarBane\fR variable as a Tcl list.
@@ -45,8 +45,8 @@ concerning braces and quotes and backslashes as the Tcl command
interpreter; however, variable
substitution and command substitution do not occur.
The command constructs a new list in which the designated element is
-replaced with \fInewValue\fP. This new list is stored in the
-variable \fIvarName\fP, and is also the return value from the \fBlset\fP
+replaced with \fInewValue\fR. This new list is stored in the
+variable \fIvarName\fR, and is also the return value from the \fBlset\fR
command.
.PP
If \fIindex\fR is negative or greater than or equal to the number
@@ -67,7 +67,7 @@ or
.CS
lset a {1 2} newValue
.CE
-replaces element 2 of sublist 1 with \fInewValue\fP.
+replaces element 2 of sublist 1 with \fInewValue\fR.
.PP
The integer appearing in each \fIindex\fR argument must be greater
than or equal to zero. The integer appearing in each \fIindex\fR
@@ -75,30 +75,32 @@ argument must be strictly less than the length of the corresponding
list. In other words, the \fBlset\fR command cannot change the size
of a list. If an index is outside the permitted range, an error is reported.
.SH EXAMPLES
-In each of these examples, the initial value of \fIx\fP is:
+In each of these examples, the initial value of \fIx\fR is:
.CS
set x [list [list a b c] [list d e f] [list g h i]]
=> {a b c} {d e f} {g h i}
.CE
-The indicated return value also becomes the new value of \fIx\fP.
+The indicated return value also becomes the new value of \fIx\fR
+(except in the last case, which is an error which leaves the value of
+\fIx\fR unchanged.)
.CS
lset x {j k l} => j k l
lset x {} {j k l} => j k l
lset x 0 j => j {d e f} {g h i}
lset x 2 j => {a b c} {d e f} j
lset x end j => {a b c} {d e f} j
-lset x end-1 j => {a b c} j {d e f}
+lset x end-1 j => {a b c} j {g h i}
lset x 2 1 j => {a b c} {d e f} {g j i}
lset x {2 1} j => {a b c} {d e f} {g j i}
-lset x {2 3} j
+lset x {2 3} j => \fIlist index out of range\fR
.CE
-In the following examples, the initial value of \fIx\fP is:
+In the following examples, the initial value of \fIx\fR is:
.CS
set x [list [list [list a b] [list c d]] \e
[list [list e f] [list g h]]]
=> {{a b} {c d}} {{e f} {g h}}
.CE
-The indicated return value also becomes the new value of \fIx\fP.
+The indicated return value also becomes the new value of \fIx\fR.
.CS
lset x 1 1 0 j => {{a b} {c d}} {{e f} {j h}}
lset x {1 1 0} j => {{a b} {c d}} {{e f} {j h}}