well-typed / cborg

Binary serialisation in the CBOR format
https://hackage.haskell.org/package/cborg
188 stars 86 forks source link

Documentation links to re-export of Builder from binary package #144

Open treeowl opened 7 years ago

treeowl commented 7 years ago

The documentation has some funny links. If you click on the Builder in the type of serialiseIncremental, for example, it will take you to documentation for Data.Binary.Builder.

My best guess: Haddock sees that Builder is exported by Data.ByteString.Lazy.Internal (which is imported by Codec.Serialise). It recognizes that D.B.L.Internal is hidden from Haddock, and goes in search of an appropriate target. Somehow (and I really have no idea how) it selects binary.

hvr commented 7 years ago

/cc @alexbiehl