[m-rev.] Re: missing library documentation

[Fergus Henderson]

On 19-Aug-2002, Zoltan Somogyi <zs at cs.mu.OZ.AU> wrote:
> 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.

OK, I'll document those.

> > > +	% 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?

When I asked you to add documentation for *_bound_search,
I didn't say *where* you should add it.  In the case of tree234,
it turns out that the right place is in map.m.

If I had known that at the time I asked, I would have been more
specific in my request.  But at that time I hadn't investigated
it in any detail.

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