VARIABLE ROLE: Document the format and add a test.
[pspp] / doc / transformation.texi
index 63f85e9ee929bc517bd254ac1898077159aff3f8..dfacfcdaed1e5bb19e8e6055bdfef9b479dea12c 100644 (file)
@@ -528,11 +528,9 @@ If the source variables are string variables then @var{src_value} may be a
 literal string (like all strings, enclosed in single or double quotes).
 @item @var{num1} THRU @var{num2}
 This form is valid only when the source variables are numeric.
-It specifies all values in the range [@var{num1}, @var{num2}].
-Normally you would ensure that @var{num2} is greater than or equal to
-@var{num1}.
-If @var{num1} however is greater than @var{num2}, then the range 
-[@var{num2},@var{num1}] will be used instead.
+It specifies all values in the range between @var{num1} and @var{num2},
+including both endpoints of the range.  By convention, @var{num1}
+should be less than @var{num2}.
 Open-ended ranges may be specified using @samp{LO} or @samp{LOWEST} 
 for @var{num1}
 or @samp{HI} or @samp{HIGHEST} for @var{num2}.
@@ -581,13 +579,17 @@ The behaviour of the command is slightly different depending on whether it
 appears or not.
 
 If @samp{INTO @var{dest_vars}} does not appear, then values will be recoded
-``in place´´.  This means that the recoded values are written back to the
+``in place´´.
+This means that the recoded values are written back to the
 source variables from whence the original values came.
 In this case, the @var{dest_value} for every mapping must imply a value which
 has the same type as the @var{src_value}.
 For example, if the source value is a string value, it is not permissible for
 @var{dest_value} to be @samp{SYSMIS} or another forms which implies a numeric
 result.
+It is also not permissible for @var{dest_value} to be  longer than the width
+of the source variable.
+
 The following example two numeric variables @var{x} and @var{y} are recoded
 in place.
 Zero is recoded to 99, the values 1 to 10 inclusive are unchanged,