GHC.Generics needs more documentation
|Reported by:||tibbe||Owned by:|
|Type of failure:||Documentation bug||Difficulty:||Unknown|
|Test Case:||Blocked By:|
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!
Change History (4)
comment:3 Changed 6 months ago by hvr
- Milestone set to 7.8.1
- Type of failure changed from None/Unknown to Documentation bug