Skip to content

clash-lib-hedgehog: weird Haddock warning #2462

Open
@DigitalBrains1

Description

@DigitalBrains1

Generating Haddock for clash-lib-hedgehog gives the warning:

Warning: Clash.Hedgehog.Core.Monad: could not find link destinations for:

        - Text.ParserCombinators.ReadP.P

This is a really weird interaction with the module doing this:

module Clash.Hedgehog.Core.Monad
  ( 

    -- * Re-exports
  , Alternative(..)

  ) where

There is indeed a non-exported type P in the mentioned module, and it is an instance of Alternative. So Haddock lists it in its list of instances here, and fails to link it. Note that this module, defined in base, has nothing to do with the code whatsoever. The following test also gives the error message:

$ cat reexp-alt.cabal 
cabal-version:      2.2
name:               reexp-alt
version:            0.0.0.0

library
  hs-source-dirs: src
  default-language: Haskell2010
  build-depends: base
  exposed-modules: ReExpAlt
$ cat src/ReExpAlt.hs 
module ReExpAlt
  ( Alternative(..)
  ) where

import Control.Applicative (Alternative(..))
$ cabal haddock
Resolving dependencies...
Build profile: -w ghc-9.2.7 -O1
In order, the following will be built (use -v for more details):
 - reexp-alt-0.0.0.0 (lib) (first run)
Configuring library for reexp-alt-0.0.0.0..
Preprocessing library for reexp-alt-0.0.0.0..
Running Haddock on library for reexp-alt-0.0.0.0..
  50% (  1 /  2) in 'ReExpAlt'
  Missing documentation for:
    Module header
Warning: ReExpAlt: could not find link destinations for:

        - Text.ParserCombinators.ReadP.P
Documentation created:
/home/peter/src/haskell/experiments/reexp-alt/dist-newstyle/build/x86_64-linux/ghc-9.2.7/reexp-alt-0.0.0.0/doc/html/reexp-alt/index.html

As long as this weird issue exists, we cannot enable the CI check that checks there are no warnings of the type could not find link destinations.

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions