Regression in Haddocks for Language.Template.Haskell.TH.Syntax

Compare https://hackage.haskell.org/package/template-haskell-2.23.0.0/docs/Language-Haskell-TH-Syntax.html to https://hackage.haskell.org/package/template-haskell-2.22.0.0/docs/Language-Haskell-TH-Syntax.html

We seem to be missing a lot of the Haddocks.

I think this might be a result of stuff being moved to ghc-internal.

If someone knows the cause I'd be happy to try to fix it.

added needs triage label

https://hackage.haskell.org/package/template-haskell-2.23.0.0/docs/Language-Haskell-TH-PprLib.html also need to be fixed

added Phigh documentation labels and removed needs triage label

added Tbug label

changed milestone to %9.12.2

Thanks for reporting this @teo, looks pretty serious. It's rather curious given that in template-haskell-2.23 Language.Haskell.TH.Syntax re-exports GHC.Internal.TH.Syntax, so it's curious that it's missing the Haddocks. Other modules that re-export from ghc-internal don't seem to suffer from the same issue, e.g. GHC.Base re-exports modules wholesale from ghc-internal in the same way, but no documentation seems to be missing.

Do you have any idea what might be going on @teo? Also pinging haddock experts: @Kleidukos @wz1000

It might be because these modules are re-exposed via ghc-boot-th?

mentioned in issue #25727 (closed)

marked #25727 (closed) as a duplicate of this issue

marked this issue as related to #25727 (closed)

mentioned in commit b605aaec

I think there are two issues here. One is that we are reexposing modules, and this is confusing Haddock. This is going to be resolved by: !14008 (closed)

The other is that many of these modules are re-exporting identifiers without an export list. We still need to add export lists to these modules.

mentioned in merge request !14008 (closed)

mentioned in commit a11f77fe

mentioned in commit 5c89d2bf

mentioned in commit 26ee501b

mentioned in commit f2d43e11

added TemplateHaskell label

mentioned in commit cbca345d

mentioned in merge request !14063 (closed)

It turns out the the fix for this was just adding a ghc-internal dependency to template-haskell. For some reason without a direct dependency Haddock couldn't see the definitions. This is either a hadrian or haddock bug.

See !14063 (closed) for the fix