Re: [GHC] #12519: Rendered Haddock for Eq and Ord are missing class methods

18 Sep 2016

      #12519: Rendered Haddock for Eq and Ord are missing class methods
-------------------------------------+-------------------------------------
        Reporter:  darchon           |                Owner:
            Type:  bug               |               Status:  new
        Priority:  high              |            Milestone:  8.0.2
       Component:  Documentation     |              Version:  8.0.1
      Resolution:                    |             Keywords:  newcomer
Operating System:  Unknown/Multiple  |         Architecture:
 Type of failure:  Documentation     |  Unknown/Multiple
  bug                                |            Test Case:
      Blocked By:                    |             Blocking:
 Related Tickets:                    |  Differential Rev(s):
       Wiki Page:                    |
-------------------------------------+-------------------------------------

Comment (by niteria):

 I took a look and it looks like `haddock`'s `ppClassDecl` gets:
 {{{
        Enum MinimalSig
             ClassOpSig [succ]
             ClassOpSig [pred]
             ClassOpSig [toEnum]
             ClassOpSig [fromEnum]
             ClassOpSig [enumFrom]
             ClassOpSig [enumFromThen]
             ClassOpSig [enumFromTo]
             ClassOpSig [enumFromThenTo]
 }}}
 for `Enum`, but
 {{{
        Eq MinimalSig
           TypeSig [==]
           TypeSig [/=]
 }}}

 for `Eq`.

 So we either want to:
 1. handle `TypeSig` in `haddock`, or
 2. always return `ClassOpSig` for typeclass methods

 I believe 2. is preferable.

--
Ticket URL: http://ghc.haskell.org/trac/ghc/ticket/12519#comment:4
GHC http://www.haskell.org/ghc/
The Glasgow Haskell Compiler