haskell-cafe@haskell.org
[Top] [All Lists]

Re: [Haskell-cafe] Comments from OCaml Hacker Brian Hurt

Subject: Re: [Haskell-cafe] Comments from OCaml Hacker Brian Hurt
From: David Menendez
Date: Fri, 16 Jan 2009 13:08:29 -0500
On Fri, Jan 16, 2009 at 12:19 PM, Ross Paterson <ross@xxxxxxxxxxxxxx> wrote:
> On Fri, Jan 16, 2009 at 12:00:40PM -0500, David Menendez wrote:
>> It would be nice to explain what operations have been chosen for the
>> Monoid instances of Prelude data types. (Maybe this belongs in the
>> Prelude documentation.)
>
> The right place for that is the instances, as soon as Haddock starts
> showing instance comments (http://trac.haskell.org/haddock/ticket/29).
> Then this information will be listed under both the type and the class.

In the case of Monoid, I think it would be best to have the
documentation now, and then attach them to the instances later, once
Haddock supports that.

>> I'd add a reminder that if you're defining a type with a Monoid
>> instance, your documentation should explain what the instance does.
>
> When that Haddock enhancement is done, this will be general advice for
> instances of all classes.

Sure, but it's especially important for Monoid.

-- 
Dave Menendez <dave@xxxxxxxxxxxx>
<http://www.eyrie.org/~zednenem/>
_______________________________________________
Haskell-Cafe mailing list
Haskell-Cafe@xxxxxxxxxxx
http://www.haskell.org/mailman/listinfo/haskell-cafe

<Prev in Thread] Current Thread [Next in Thread>