From 8dc91fd4313dc268bca4ad3d522914a3ad2bc6e8 Mon Sep 17 00:00:00 2001
From: dkf <donal.k.fellows@manchester.ac.uk>
Date: Sat, 22 May 2004 00:19:37 +0000
Subject: Reformulated so as to make clear what are examples.

---
 doc/concat.n | 32 +++++++++++++++++---------------
 1 file changed, 17 insertions(+), 15 deletions(-)

diff --git a/doc/concat.n b/doc/concat.n
index 52f4094..dded6a2 100644
--- a/doc/concat.n
+++ b/doc/concat.n
@@ -5,7 +5,7 @@
 '\" 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.4 2002/07/01 10:50:21 dkf Exp $
+'\" RCS: @(#) $Id: concat.n,v 1.5 2004/05/22 00:19:37 dkf Exp $
 '\" 
 .so man.macros
 .TH concat n 8.3 Tcl "Tcl Built-In Commands"
@@ -20,28 +20,30 @@ concat \- Join lists together
 .SH DESCRIPTION
 .PP
 This command joins each of its arguments together with spaces after
-trimming leading and trailing spaces from each of them.  If all the
+trimming leading and trailing white-space from each of them.  If all the
 arguments are lists, this has the same effect as concatenating them
 into a single list.
-It permits any number of arguments.  For example, the command
+It permits any number of arguments;
+if no \fIarg\fRs are supplied, the result is an empty string.
+.SH EXAMPLES
+Although \fBconcat\fR will concatenate lists (so the command:
 .CS
-\fBconcat a b {c d e} {f {g h}}\fR
+concat a b {c d e} {f {g h}}
 .CE
-will return
+will return "\fBa b c d e f {g h}\fR" as its result), it will also
+concatenate things that are not lists, and hence the command:
 .CS
-\fBa b c d e f {g h}\fR
+concat " a b {c   " d "  e} f"
 .CE
-as its result, and
-.CS
-\fBconcat " a b {c   " d "  e} f"\fR
-.CE
-will return
+will return "\fBa b {c d e} f\fR" as its result.
+
+Note that the concatenation does not remove spaces from the middle of
+its arguments, so the command:
 .CS
-\fBa b {c d e} f\fR
+concat "a   b   c" { d e f }
 .CE
-as its result.
-.PP
-If no \fIarg\fRs are supplied, the result is an empty string.
+will return "\fBa   b   c d e f\fR" (i.e. with three spaces between
+the \fBa\fR, the \fBb\fR and the \fBc\fR).
 
 .SH "SEE ALSO"
 append(n), eval(n)
-- 
cgit v0.12