[GHC] #8416: GHC.Generics needs more documentation

[GHC]

#8416: GHC.Generics needs more documentation
-------------------------------------+-------------------------------------
       Reporter:  tibbe              |             Owner:
           Type:  bug                |            Status:  new
       Priority:  normal             |         Milestone:
      Component:  libraries (other)  |           Version:  7.6.3
       Keywords:                     |  Operating System:  Unknown/Multiple
   Architecture:  Unknown/Multiple   |   Type of failure:  None/Unknown
     Difficulty:  Unknown            |         Test Case:
     Blocked By:                     |          Blocking:
Related Tickets:                     |
-------------------------------------+-------------------------------------
 Recently I tried to used `GHC.Generics` "in anger" for the first time, to
 fix some code in hashable that wasn't originally written by me. After a
 while I just gave up (and the generics support in hashable is now somewhat
 broken). The documentation for `GHC.Generics` is too incomprehensible for
 mere mortals. In particular, I find the documentation for `M1` and `K1`
 not very helpful.

 The documentation needs examples, more in-depth explanations of what each
 of the data types/constructors is used for, and finally an explanation of
 the up to 4 type parameters!

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