[m-rev.] for review: map.m documentation improvements

[Fergus Henderson]

Estimated hours taken: 0.25
Branches: main

library/map.m:
	Add some documentation for map__member and map__set_from_assoc_list.

Workspace: /home/ceres/fjh/mercury
Index: library/map.m
===================================================================
RCS file: /home/mercury1/repository/mercury/library/map.m,v
retrieving revision 1.80
diff -u -d -r1.80 map.m
--- library/map.m	24 May 2001 02:32:28 -0000	1.80
+++ library/map.m	20 Aug 2002 10:55:12 -0000
@@ -45,6 +45,8 @@
 :- pred map__contains(map(K,_V), K).
 :- mode map__contains(in, in) is semidet.
 
+	% Nondeterministically produce all the keys
+	% and corresponding values in a map.
 :- pred map__member(map(K,V), K, V).
 :- mode map__member(in, out, out) is nondet.
 
@@ -113,6 +115,7 @@
 :- func map__set_from_corresponding_lists(map(K,V), list(K), list(V)) =
 		map(K,V).
 
+	% Apply map__set to key - value pairs from an association list.
 :- pred map__set_from_assoc_list(map(K,V), assoc_list(K, V), map(K,V)).
 :- mode map__set_from_assoc_list(in, in, out) is det.
 

-- 
Fergus Henderson <fjh at cs.mu.oz.au>  |  "I have always known that the pursuit
The University of Melbourne         |  of excellence is a lethal habit"
WWW: <http://www.cs.mu.oz.au/~fjh>  |     -- the last words of T. S. Garp.
--------------------------------------------------------------------------
mercury-reviews mailing list
post:  mercury-reviews at cs.mu.oz.au
administrative address: owner-mercury-reviews at cs.mu.oz.au
unsubscribe: Address: mercury-reviews-request at cs.mu.oz.au Message: unsubscribe
subscribe:   Address: mercury-reviews-request at cs.mu.oz.au Message: subscribe
--------------------------------------------------------------------------