Generate docs for orphan instances in the module where they are defined

[ghc-mirror]

Original reporter: mail+haddock-trac@

It often happens that orphan instances are declared in an .Instances module of a package, e.g. http://hackage.haskell.org/package/vect-0.4.7/docs/Data-Vect-Double-Instances.html.

It is very impractical that Haddock generates empty pages for this.

It would be great if haddock could always generate instance documentation for orphan instances in modules are defined.

[chowells79]

This really would be very handy.

[mgsloan]

What happened with this? Is hackage using too old of a haddock?

Store has many instances, I'd expect to see them here https://hackage.haskell.org/package/store-0.1.0.1/docs/Data-Store-Internal.html or here https://hackage.haskell.org/package/store-0.1.0.1/docs/Data-Store.html

Pinging @phadej since he implemented the fix in #449

[phadej]

N@mgsloan seems to be in haddock bundled with ghc8: http://docs.futurice.com/haskell-mega-repo/futurice-prelude-0.1.9.0/Futurice-Prelude-Internal-Orphans.html (IIRC hackage uses GHC 7.10, and there aren't haddock with orphans for it)

[bgamari]

Oleg Grenrus notifications@github.com writes:

@mgsloan seems to be in haddock bundled with ghc8:
http://docs.futurice.com/haskell-mega-repo/futurice-prelude-0.1.9.0/Futurice-Prelude-Internal-Orphans.html

Indeed, we'll need to update the Haddock version used by the Hackage
documentation builder. @davean, how can we make this happen?

[davean]

I can take care of that, what has to happen?

On Thu, May 26, 2016 at 5:48 AM, Ben Gamari notifications@github.com
wrote:

Oleg Grenrus notifications@github.com writes:

@mgsloan seems to be in haddock bundled with ghc8:

http://docs.futurice.com/haskell-mega-repo/futurice-prelude-0.1.9.0/Futurice-Prelude-Internal-Orphans.html

Indeed, we'll need to update the Haddock version used by the Hackage
documentation builder. @davean, how can we make this happen?

—
You are receiving this because you were mentioned.
Reply to this email directly or view it on GitHub
#297 (comment)

[bgamari]

davean notifications@github.com writes:

I can take care of that, what has to happen?

You will need to update on the builder to GHC to 8.0.1 and ensure that
the haddock shipped with this release is used by the builder.

Cheers,

• Ben

[bgamari]

Ben Gamari ben@smart-cactus.org writes:

[ Unknown signature status ]
davean notifications@github.com writes:

I can take care of that, what has to happen?

You will need to update on the builder to GHC to 8.0.1 and ensure that
the haddock shipped with this release is used by the builder.

Any news on this?

[Blaisorblade]

This (?) is hiding instances for Text from Text, because its instances are somehow technically orphans (?) (instances in Data.Text, datatype definition in Data.Text.Internal):
http://hackage.haskell.org/package/text-1.2.2.1/docs/Data-Text.html#g:4

[phadej]

It's not this. IIRC the bug was present in haddock shipped with GHC7.10 already. Seems there aren't an issue for that though. There are similar bugs reports already

• Array documentation is missing its Read instance #469
• Documentation for base-4.8.0.0 doesn't mention Show Double or Show Float instances #372