summaryrefslogtreecommitdiffstats
path: root/doc/dict.n
diff options
context:
space:
mode:
authorandy <andrew.m.goth@gmail.com>2014-05-21 22:00:52 (GMT)
committerandy <andrew.m.goth@gmail.com>2014-05-21 22:00:52 (GMT)
commit165042b1e0a2ca0d5acee8dbfdbf151978998ea4 (patch)
tree2f50d656dc0e7fb916135b424e94eb4accc1672a /doc/dict.n
parent1e2ced92480ce68bbf628c8848e0d41bd18521e2 (diff)
downloadtcl-165042b1e0a2ca0d5acee8dbfdbf151978998ea4.zip
tcl-165042b1e0a2ca0d5acee8dbfdbf151978998ea4.tar.gz
tcl-165042b1e0a2ca0d5acee8dbfdbf151978998ea4.tar.bz2
Ditto [dict append], [dict incr], and [dict lappend]. Update description of [dict create] to explicitly state that it returns the new dictionary.
Diffstat (limited to 'doc/dict.n')
-rw-r--r--doc/dict.n11
1 files changed, 7 insertions, 4 deletions
diff --git a/doc/dict.n b/doc/dict.n
index 32d7ea8..3bb5465 100644
--- a/doc/dict.n
+++ b/doc/dict.n
@@ -25,11 +25,12 @@ below for a description), depending on \fIoption\fR. The legal
This appends the given string (or strings) to the value that the given
key maps to in the dictionary value contained in the given variable,
writing the resulting dictionary value back to that variable.
-Non-existent keys are treated as if they map to an empty string.
+Non-existent keys are treated as if they map to an empty string. The
+updated dictionary value is returned.
.TP
\fBdict create \fR?\fIkey value ...\fR?
.
-Create a new dictionary that contains each of the key/value mappings
+Return a new dictionary that contains each of the key/value mappings
listed as arguments (keys and values alternating, with each key being
followed by its associated value.)
.TP
@@ -121,7 +122,8 @@ not specified) to the value that the given key maps to in the
dictionary value contained in the given variable, writing the
resulting dictionary value back to that variable. Non-existent keys
are treated as if they map to 0. It is an error to increment a value
-for an existing key if that value is not an integer.
+for an existing key if that value is not an integer. The updated
+dictionary value is returned.
.TP
\fBdict info \fIdictionaryValue\fR
.
@@ -145,7 +147,8 @@ to in the dictionary value contained in the given variable, writing
the resulting dictionary value back to that variable. Non-existent
keys are treated as if they map to an empty list, and it is legal for
there to be no items to append to the list. It is an error for the
-value that the key maps to to not be representable as a list.
+value that the key maps to to not be representable as a list. The
+updated dictionary value is returned.
.TP
\fBdict map \fR{\fIkeyVar valueVar\fR} \fIdictionaryValue body\fR
.