[m-dev.] for review: add streams to extras

[Fergus Henderson]

On 21-Nov-2000, Peter Ross <peter.ross at miscrit.be> wrote:
> 
> Just needs a review of the README.
> 
> ===================================================================
> 
> 
> Estimated hours taken: 50
> 
> Mmakefile:
> README:
> impure.m:
> lowlevel.m:
> stream.m:
>     Add the stream library.

The log message should include the directory names for the files,
e.g.
	extras/streams/Mmakefile:
	...

In general the log message should also give a rationale for
the change; in this case that would mean having a brief summary of
what the stream library is and what it is good for.  E.g.
something like

	Add the stream library.  This library provides support for
	generic I/O stream handling using type classes.

> +++ README	Wed Nov 22 04:10:13 2000
> @@ -0,0 +1,26 @@
> +This directory contains an implementation of generic IO streams in Mercury.

I think it would help to have some more explanation here, e.g.

	The streams interface uses type classes, so that users can
	define their own stream types and can write generic code that
	will work on any appropriate stream.

-- 
Fergus Henderson <fjh at cs.mu.oz.au>  |  "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
--------------------------------------------------------------------------