Skip to content
This repository has been archived by the owner on Aug 3, 2024. It is now read-only.

Haddock doesn't show type instances as orphans #1502

Open
silky opened this issue Jul 15, 2022 · 0 comments
Open

Haddock doesn't show type instances as orphans #1502

silky opened this issue Jul 15, 2022 · 0 comments

Comments

@silky
Copy link

silky commented Jul 15, 2022

It would be really nice if, when I have orphan type instance ... statements, they would show up in the documentation of the file where I'm defining them.

Compare:

-- A.hs
{-# language TypeFamilies #-}

module A where

-- | Some witty observations about the type family.
type family B a :: *

-- | Some insightful observations about this bool instance.
type instance B Bool = Int

image

vs.

--- A.hs
{-# language TypeFamilies #-}

module A where

import B

-- | Some insightful observations about this bool instance.
type instance B Bool = Int
-- B.hs
{-# language TypeFamilies #-}

module B where

-- | Some witty observations about the type family.
type family B a :: *

Now:

image

image

:(

I'd love to see the instance for 'B' defined in the 'A' module. Is there a way to achieve this?

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant