search

IntersectMBO / cardano-ledger

The ledger implementation and specifications of the Cardano blockchain.
Apache License 2.0
259 stars 157 forks source link

Haddock is generated for hidden modules #3582

Closed lehins closed 1 month ago

lehins commented 1 year ago

It makes no sense to generate haddock for modules that can't be imported from outside of the package. This doesn't happen on Hackage and should not happen for Haddock that we generate for Ledger packages.

For example individuals rules are in the other-modules section, but Haddock is still generated:

image

neilmayhew commented 6 months ago

Unfortunately, #4257 didn't end up fixing this, so we can't close this ticket yet

coot commented 2 months ago

If you use cabal haddock-project, then this issue will resurface: haskell/cabal#10157; anyway if you decide to use cabal haddock-project then use head instead of 3.12.1.0 as it has some other fixes. We'll use it in ouroboros-network IntersectMBO/ouroboros-network#4944, we already use it for io-sim.

lehins commented 2 months ago

4578 didn't fix it either. Reopening.

@coot Thank you for suggestions!

@aniketd See if you can get cabal haddock-project to work.