diff --git a/tconfpy.3 b/tconfpy.3 index b9647c4..860c2e2 100644 --- a/tconfpy.3 +++ b/tconfpy.3 @@ -396,6 +396,14 @@ SymTable['COLOR'] = des .fi +.B NOTE: +If you want this test to be skipped, then set \'LegalVals\' to an +empty list, []. (This is the default when you first create an +instance of \'tconfpy.VarDescriptor\'.) Do not set it to a Python +None or anything else. \*(TC expects this attribute to be a list in +every case. + + .TP .B VarDescriptor.Min and VarDescriptor.Max (Default: None) @@ -416,8 +424,8 @@ .fi -In all cases, if you want these tests skipped, set \'Min\' or \'Max\' -to the Python None. +In all cases, if you want either of these tests skipped, set \'Min\' +or \'Max\' to the Python None. .P All these various validations are logically "ANDed" together. @@ -1496,10 +1504,13 @@ enforces restrictions on variables: .IP \(bu 4 -Within the configuration file, +For purposes of processing the configuration file, .B variable references are always converted to strings -regardless of the actual type of the variable in question. For -instance, suppose the programmer defines variable \'Foo\' to be +regardless of the actual type of the variable in question. (Variables are +.B stored in the symbol table +in their actual type.) + +For instance, suppose the programmer defines variable \'Foo\' to be floating point. Then: .nf @@ -1509,13 +1520,26 @@ .fi In other words, variable values are "coerced" into strings for -the purposes of substution and conditional testing within a -configuration file. +the purposes of substitution and conditional testing within a +configuration file. This is primarily an issue with +the conditional comparisons below. For example, the following +conditional is False because the string representations of the +two numbers are different. Assume \'f1\' and \'f2\' have been +defined as floating point variables by the calling program: + +.nf + f1 = 1.0 + f2 = 1.00 + + .if [f1] == [f2] # False because "1.0" is not the same string as "1.00" + ... +.fi .IP \(bu 4 -You cannot create anything but a string variable with no limitations -from within a configuration file. All validation features +You cannot create anything but a string variable within a +configuration file. This variable will have no restrictions placed on +its values. All validation features .B require the limitations to be specified by the calling program ahead of time.