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

Fergus Henderson fjh at cs.mu.OZ.AU
Tue Mar 23 17:54:59 AEDT 2004


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.

Not that that one has actually been observed!

-- 
Fergus Henderson                    |  "I have always known that the pursuit
                                    |  of excellence is a lethal habit"
WWW: <http://www.cs.mu.oz.au/~fjh>  |     -- the last words of T. S. Garp.
--------------------------------------------------------------------------
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
--------------------------------------------------------------------------



More information about the developers mailing list