[Haddock] Feature request: type signatures in index overview

[David Waern]

Hi,

I think it's a good idea. We could probably find ways to shorten the
types/definitions. For large function type signatures we could e.g truncate
them adding " -> ..." at the end (or in the middle). For types we could
e.g. choose to not show the definition if it's too big.

David



2013/9/10 Mateusz Kowalczyk <fuuzetsu at fuuzetsu.co.uk>

> On 09/09/13 23:15, David Luposchainsky wrote:
> > Hey Haddock devs,
> >
> > I've recently spent a lot of time in the GHC source and was clicking
> > through names in the index just to find out the types for certain
> > identifiers. Paired with the large amount of empty space the index table
> > has, I thought it would be a good idea to fill that empty space with
> > type signatures. The index would then have three columns: name, defining
> > module, type. (For types/newtypes the actual definition could be filled
> > in instead.) What do you think?
> >
> > Greetings,
> > David/quchen
> >
> > _______________________________________________
> > Haddock mailing list
> > Haddock at projects.haskell.org
> > http://projects.haskell.org/cgi-bin/mailman/listinfo/haddock
> >
> While I don't have anything against it, do you have a mockup of what
> that would look like in the end? I imagine that something like lens[1]
> would get quite congested, with its rather large types and multiple
> listed modules. What about some huge types, such as those for records
> (DynFlags comes to mind)?
>
> It's probably also better to open a ticket (as Enhancement) and discuss
> it there, much easier to track and definitely more searchable.
>
> [1]:
>
> http://hackage.haskell.org/packages/archive/lens/3.9.1/doc/html/doc-index-M.html
>
> --
> Mateusz K.
>
> _______________________________________________
> Haddock mailing list
> Haddock at projects.haskell.org
> http://projects.haskell.org/cgi-bin/mailman/listinfo/haddock
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://projects.haskell.org/pipermail/haddock/attachments/20130910/a9b4d010/attachment.htm>