[Haskell-cafe] Haddock: Documentation of instances with un-documentable type arguments

Alexander McPhail haskell.vivian.mcphail at gmail.com
Sat Sep 4 05:01:41 EDT 2010


Is there a similar ticket for GHC to not export instances in the case that
other instances are explicitly specified?

module Foo (

instance Monad Foo where ...
instance MonadState (Foo Bar) where ...

i.e. the monad instance gets exported but the MonadState one does not?  This
helps in maintaining opacity with respect to the package user.  I may not
want the user to be able to call 'get' and 'put' when using my custom monad.



On 26 August 2010 02:20, David Waern <david.waern at gmail.com> wrote:

> 2010/8/25 Alexander McPhail <haskell.vivian.mcphail at gmail.com>:
> > Perhaps Haddock could exclude class instance reporting when it cannot
> find a
> > documentable link to a parameter?
> Yes, it should. BTW, we have a trac ticket for it:
>  http://trac.haskell.org/haddock/ticket/37
> You can add yourself to the CC list to show that you want this feature.
> Currently we don't have many people working on these types of tickets
> in Haddock (I'm mostly fixing bugs, others are working on bigger
> improvements), so if more people would volunteer to help out, that'd
> be great. The mailing list haddock at projects.haskell.org can be used to
> ask for directions and help.
> David

yolar et elver.


This transmission contains information that may be confidential. It is
intended for the named addressee only. Unless you are the named addressee
you may not copy or use it or disclose it to anyone else.
-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://www.haskell.org/pipermail/haskell-cafe/attachments/20100904/e03f3b9f/attachment.html

More information about the Haskell-Cafe mailing list