Haddock strings in .hi files

Herbert Valerio Riedel hvriedel at gmail.com
Thu Mar 20 10:45:36 UTC 2014


On 2014-03-20 at 11:39:47 +0100, Mateusz Kowalczyk wrote:
> [...] the functionality to grab documentation for something can be
> provided by Haddock and GHCi then can use that. I think an extra
> benefit of this is that we get to decide in Haddock how we present
> such documentation: we can have different pretty printers if we so
> desire. If the strings are in .hi files themselves, the only choice is
> to show them verbatim which can be sub-par.
>
> So if having documentation in GHCi is the sole goal, I think it's not
> worth putting the strings in the .hi file.

Just wondering: how would GHCi have to handle the case of e.g. ':reload'
(in "-fobject-code" as well as "-fbyte-code" mode), in order to have
access to up-to-date Haddock strings?


More information about the ghc-devs mailing list