[m-dev.] for review: improve documentation for list__zip

[Fergus Henderson]

Does this look OK?

----------

Estimated hours taken: 0.25

library/list.m:
	Improve the documentation for list__zip.

Workspace: /home/mercury0/fjh/mercury
Index: library/list.m
===================================================================
RCS file: /home/mercury1/repository/mercury/library/list.m,v
retrieving revision 1.88
diff -u -d -r1.88 list.m
--- list.m	1999/07/07 15:19:40	1.88
+++ list.m	2000/01/23 05:55:43
@@ -293,8 +293,12 @@
 
 	% list__zip(ListA, ListB, List):
 	%	List is the result of alternating the elements
-	%	of ListA and ListB.  When one of the lists goes to empty,
-	% 	the remainder of the nonempty list is appended.
+	%	of ListA and ListB, starting with the first element
+	%	of ListA (followed by the first element of ListB,
+	%	then the second element of listA, then the second
+	%	element of ListB, etc.).  When one of the lists goes
+	% 	to empty, the remainder of the nonempty list is
+	%	appended.
 	%
 :- pred list__zip(list(T), list(T), list(T)).
 :- mode list__zip(in, in, out) is det.

-- 
Fergus Henderson <fjh at cs.mu.oz.au>  |  "I have always known that the pursuit
WWW: <http://www.cs.mu.oz.au/~fjh>  |  of excellence is a lethal habit"
PGP: finger fjh at 128.250.37.3        |     -- the last words of T. S. Garp.
--------------------------------------------------------------------------
mercury-developers mailing list
Post messages to:       mercury-developers at cs.mu.oz.au
Administrative Queries: owner-mercury-developers at cs.mu.oz.au
Subscriptions:          mercury-developers-request at cs.mu.oz.au
--------------------------------------------------------------------------