Positional cues or not

malcolm-hs@cs.york.ac.uk malcolm-hs@cs.york.ac.uk
Tue, 13 Feb 2001 12:18:13 +0000


> Please - if we're going to adopt this kind of style, don't make it
> needlessly divergent from existing conventions.  There's no reason to
> use {- @DOC -} instead of {-# DOC #-}.

I agree, let's not be divergent.  {- @DOC -} is just as ugly as {-# DOC #-}.
And I would still be extremely reluctant to use either of them.  :-(
The capital letters and #/@ are just too ... big and black!
(Your fonts may differ.)

> The end of line version could be:
> 
> 	--# DOC
> 	-- Documentation goes here...
> 	--

Sorry, that breaks Haskell'98.   --#  is a valid operator symbol.

> But, some people clearly prefer a style which is easier on the eye, in
> which case the {--- -} and --- are fine by me.

Triple dashes are nice because they
    *  have low visual density (not too obtrusive)
    *  look the same for nested/end-of-line varieties without breaking H'98

Regards,
    Malcolm