On 4/7/06, Juliusz Chroboczek <[EMAIL PROTECTED]> wrote:
>
> > +apply :: WriteableDirectory m
> > +      => [DarcsFlag]
> > +      -> Bool -- ^ working directory - if True, this means some 
> > inconsitencies such
> > +              --   as removing a non-empty directory are treated as 
> > warnings, not
> > +              --   errors.  When in doubt, set to False.
> > +      -> Patch -> m ()
>
> I prefer comments to be separated from the type, so that the type
> remains compact and easily readable.  But that's just me.

I agree usually, but in this case I think it's worth it because those
comments can be picked up by haddock and are roughly equivalent to
@param in javadoc comments.  Plus, the type "Bool" tells you very
little without the comment so something is needed and I think haddock
is a good idea.  In conclusion, I'd say Eric commented it the right
way in this case. :)

Just my $0.02,
Jason

_______________________________________________
darcs-devel mailing list
[email protected]
http://www.abridgegame.org/cgi-bin/mailman/listinfo/darcs-devel

Reply via email to