Documented the *real* behaviour of [concat]

2 files changed, 18 insertions, 7 deletions

diff --git a/ChangeLog b/ChangeLog
index 599c76c..788fd21 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,7 @@
+2002-07-01  Donal K. Fellows  <fellowsd@cs.man.ac.uk>
+
+	* doc/concat.n: Documented the *real* behaviour of [concat]!
+
 2002-06-30  Don Porter  <dgp@users.sourceforge.net>
 
 	* doc/tcltest.n: more work in progress updating tcltest docs.
diff --git a/doc/concat.n b/doc/concat.n
index c04eaf0..52f4094 100644
--- a/doc/concat.n
+++ b/doc/concat.n
@@ -5,10 +5,10 @@
 '\" See the file "license.terms" for information on usage and redistribution
 '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
 '\" 
-'\" RCS: @(#) $Id: concat.n,v 1.3 2000/09/07 14:27:46 poenitz Exp $
+'\" RCS: @(#) $Id: concat.n,v 1.4 2002/07/01 10:50:21 dkf Exp $
 '\" 
 .so man.macros
-.TH concat n "" Tcl "Tcl Built-In Commands"
+.TH concat n 8.3 Tcl "Tcl Built-In Commands"
 .BS
 '\" Note:  do not modify the .SH NAME line immediately below!
 .SH NAME
@@ -19,12 +19,11 @@ concat \- Join lists together
 
 .SH DESCRIPTION
 .PP
-This command treats each argument as a list and concatenates them
+This command joins each of its arguments together with spaces after
+trimming leading and trailing spaces from each of them.  If all the
+arguments are lists, this has the same effect as concatenating them
 into a single list.
-It also eliminates leading and trailing spaces in the \fIarg\fR's
-and adds a single separator space between \fIarg\fR's.
-It permits any number of arguments.  For example,
-the command
+It permits any number of arguments.  For example, the command
 .CS
 \fBconcat a b {c d e} {f {g h}}\fR
 .CE
@@ -32,6 +31,14 @@ will return
 .CS
 \fBa b c d e f {g h}\fR
 .CE
+as its result, and
+.CS
+\fBconcat " a b {c   " d "  e} f"\fR
+.CE
+will return
+.CS
+\fBa b {c d e} f\fR
+.CE
 as its result.
 .PP
 If no \fIarg\fRs are supplied, the result is an empty string.