[GHC] #13175: Documenting what can be derived 'out of the box' by GHC's "deriving"

GHC ghc-devs at haskell.org
Tue Jan 24 17:31:53 UTC 2017


#13175: Documenting what can be derived 'out of the box' by GHC's "deriving"
-------------------------------------+-------------------------------------
        Reporter:  carette           |                Owner:
            Type:  task              |               Status:  new
        Priority:  normal            |            Milestone:
       Component:  Documentation     |              Version:  8.0.1
      Resolution:                    |             Keywords:
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 RyanGlScott):

 Thank you for the report.

 So you're correct in that the list of //stock// derivable classes is not
 so Google-able (where `stock` is terminology that I use in the upcoming
 `DerivingStrategies` GHC extension, documented
 [https://ghc.haskell.org/trac/ghc/wiki/Commentary/Compiler/DerivingStrategies
 here]). That `DerivingStrategies` wiki page information does need to be in
 a more public location, I admit.

 The users' guide actually //does// list all of the stock derivable classes
 that are available via GHC extensions in
 http://downloads.haskell.org/~ghc/8.0.1/docs/html/users_guide/glasgow_exts.html
 #deriving-instances-of-extra-classes-data-etc. But we don't currently list
 the stock derivable classes that were already mentioned in the Haskell
 Report (`Bounded`, `Enum`, `Ix`, `Eq`, `Ord`, `Read`, and `Show`).

 If I recapped those classes in that section of the users' guide, would
 that work for you?

--
Ticket URL: <http://ghc.haskell.org/trac/ghc/ticket/13175#comment:3>
GHC <http://www.haskell.org/ghc/>
The Glasgow Haskell Compiler


More information about the ghc-tickets mailing list