[m-rev.] diff/for review: fix some documentation in library/multi_map

[Julien Fischer]

Estimated hours taken: 0.2
Branches: main

Fix some documentation in the multi_map module.

library/multi_map.m:
	Fix the documentation for multi_map.merge which was incomplete.

	s/implemention/implementation.

Julien.

Workspace:/home/earth/juliensf/ws53
Index: library/multi_map.m
===================================================================
RCS file: /home/mercury1/repository/mercury/library/multi_map.m,v
retrieving revision 1.14
diff -u -r1.14 multi_map.m
--- library/multi_map.m	24 Jan 2005 23:16:38 -0000	1.14
+++ library/multi_map.m	25 Jan 2005 06:45:54 -0000
@@ -201,8 +201,13 @@
 :- pred multi_map__from_corresponding_list_lists(list(K)::in, list(list(V))::in,
 	multi_map(K, V)::out) is det.

-	% For multi_map__merge(MultiMapA, MultiMapB, MultiMap).
-	%
+	% multi_map__merge(MultiMapA, MultiMapB, MultiMap).
+	% Merge `MultiMapA' and `MultiMapB' so that if a key occurs in
+	% both `MultiMapA' and `MultiMapB' then the values corresponding
+	% to that key in `MultiMap' will be the concatenation of
+	% the values corresponding to that key from `MultiMapA' and
+	% `MultiMapB'.
+	%
 :- func multi_map__merge(multi_map(K, V), multi_map(K, V))
 	= multi_map(K, V).
 :- pred multi_map__merge(multi_map(K, V)::in, multi_map(K, V)::in,
@@ -224,7 +229,7 @@
 	list(V)::out) is det.

 	% Declaratively, a NOP.
-	% Operationally, a suggestion that the implemention
+	% Operationally, a suggestion that the implementation
 	% optimize the representation of the multi_map in the expectation
 	% of a number of lookups but few or no modifications.
 	%

--------------------------------------------------------------------------
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
--------------------------------------------------------------------------