[m-rev.] Re: missing library documentation

[Zoltan Somogyi]

On 19-Aug-2002, Fergus Henderson <fjh at cs.mu.OZ.AU> wrote:
> For map.m, I think all the routines other than *_bound_search
> are already documented.

map__member and map__set_from_assoc_list aren't.

> > +	% Search for a key-value pair using the key.  If there is no entry
> > +	% for the given key, returns the pair for the next lower key instead.
> > +	% Fails if there is no key with the given or lower value.
> >  :- pred tree234__lower_bound_search(tree234(K, V), K, K, V).
> >  :- mode tree234__lower_bound_search(in, in, out, out) is semidet.
> ...
> 
> I think it would be better *not* to add this documentation here,
> instead relying on the comment at the top of the module.

Then why did you ask me to add it?

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