haddock icon indicating copy to clipboard operation
haddock copied to clipboard

haddock points to reexported symbol even if a symbol is imported through another module

Open guibou opened this issue 1 year ago • 2 comments

In my module, I'm importing Data.Text.Text and using it in a function signature.

However, my library depends on text and foldl and foldl reexports Text in the Control.Foldl.Text module.

Even if I'm not importing Control.Foldl.Text in my module, haddock generates links documentation to this module instead of a link to the Data.Text.Text module.

For exemple:

I've created a new library with cabal init which contains this file:

module MyLib (someFunc, fiz) where

import Data.Text

fiz :: Text
fiz = undefined

someFunc :: IO ()
someFunc = putStrLn "someFunc"

Note: this is the default library generated by cabal init with the added (and exported) fiz symbol.

Note that it imports the Data.Text module.

If I only depend on text on my cabal file, the generated haddock correctly points to Data.Text.Text. However, if I'm adding foldl in my cabal file, the generated documentation points to Control.Foldl.Text, as you can see here:

image

Changing the order of the dependencies in the cabal file does not change the result.

guibou avatar Oct 19 '22 11:10 guibou

Tried with haddock with ghc 9.0.2

guibou avatar Oct 19 '22 11:10 guibou

Could it be that this bug affects re-exports in a more general way? I have something like:

import Data.Attoparsec.ByteString.Char8

fooP :: Parser a
...

and haddock reports

could not find link destinations for:

	- Data.Attoparsec.ByteString.Internal.Parser

but Parser is re-exported by Data.Attoparsec.ByteString.Char8.

dschrempf avatar Oct 24 '22 09:10 dschrempf