[m-dev.] for discussion: coding standards and the library reference manual

[Julien Fischer]

On Tue, 23 Mar 2004, Fergus Henderson wrote:

> On 23-Mar-2004, Julien Fischer <juliensf at students.cs.mu.OZ.AU> wrote:
> > +<h2> Standard Library Predicates </h2>
> > +
> > +Any predicate or function that occurs in the interface of a standard
> > +library module must have a brief comment describing what it does.
>
> Isn't that covered by this existing sentence?
>
> 	Each predicate other than trivial access predicates should have
> 	a short comment describing what the predicate is supposed to do,
> 	and what the meaning of the arguments is.
>
True enough - my main concern was more that the documentation for
different predicates tend to change place between (and sometimes within)
modules which doesn't help the readibility of the library reference
manual.


> Not that that one has actually been observed!
>
--------------------------------------------------------------------------
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
--------------------------------------------------------------------------