Haddock doesn't include selectors from record pattern synonyms

haskell / haddock

Haskell Documentation Tool

www.haskell.org/haddock/

BSD 2-Clause "Simplified" License

361 stars 241 forks source link

Open sjakobi opened 5 years ago

sjakobi commented 5 years ago

The module

{-# language PatternSynonyms #-}
module Lib where

pattern P{x, y} = (x, y)

has the following exports:

λ :browse Lib
pattern P :: a -> b -> (a, b)
x :: (a, b) -> a
y :: (a, b) -> b

But Haddock doesn't show x and y:

sjakobi commented 5 years ago

Oops. Seems like this is already fixed in the wip/hi-haddock tree: :)

What this doesn't reveal though, is that x and y can be used in the pattern:

λ P {x = 1, y = 2}
(1,2)

harpocrates commented 5 years ago

Even ghci's :browse does a pretty terrible job of presenting the information. We need some nice output presentation that

awpr commented 2 years ago

Some updates:

When the pattern synonym is exported bundled with its parent type, its field selectors are completely missing from Haddock. They're only visible if exported separately.
This is still around, and affects https://hackage.haskell.org/package/snumber-0.1.0.0/docs/Data-SNumber.html, where the exported unSNumber is missing.