diff options
Diffstat (limited to 'doc/const.n')
| -rw-r--r-- | doc/const.n | 18 |
1 files changed, 9 insertions, 9 deletions
diff --git a/doc/const.n b/doc/const.n index b432655..9bc77ba 100644 --- a/doc/const.n +++ b/doc/const.n @@ -15,25 +15,25 @@ const \- create and initialize a constant .BE .SH DESCRIPTION .PP -This command is normally used within a procedure body (or method body, -or lambda term) to create a constant within that procedure, or within a -\fBnamespace eval\fR body to create a constant within that namespace. -The constant is an unmodifiable variable, called \fIvarName\fR, that is +This command is normally used within a procedure body (or method body, +or lambda term) to create a constant within that procedure, or within a +\fBnamespace eval\fR body to create a constant within that namespace. +The constant is an unmodifiable variable, called \fIvarName\fR, that is initialized with \fIvalue\fR. The result of \fBconst\fR is always the empty string on success. .PP -If a variable \fIvarName\fR does not exist, it is created with its value set +If a variable \fIvarName\fR does not exist, it is created with its value set to \fIvalue\fR and marked as a constant; this means that no other command (e.g., \fBset\fR, \fBappend\fR, \fBincr\fR, \fBunset\fR) -may modify or remove the variable; variables are checked for whether they +may modify or remove the variable; variables are checked for whether they are constants before any traces are called. -If a variable \fIvarName\fR already exists, it is an error unless that +If a variable \fIvarName\fR already exists, it is an error unless that variable is marked as a constant (in which case \fBconst\fR is a no-op). .PP -The \fIvarName\fR may not be a qualified name or reference an element of an +The \fIvarName\fR may not be a qualified name or reference an element of an array by any means. If the variable exists and is an array, that is an error. .PP -Constants are normally only removed by their containing procedure exiting or +Constants are normally only removed by their containing procedure exiting or their namespace being deleted. .SH EXAMPLES .PP |