Opened 5 years ago

Closed 5 years ago

Last modified 2 years ago

#8416 closed bug (fixed)

GHC.Generics needs more documentation

Reported by: tibbe Owned by:
Priority: normal Milestone: 7.8.1
Component: libraries/base Version: 7.6.3
Keywords: Generics Cc:
Operating System: Unknown/Multiple Architecture: Unknown/Multiple
Type of failure: Documentation bug Test Case:
Blocked By: Blocking:
Related Tickets: Differential Rev(s):
Wiki Page:

Description

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 (5)

comment:1 Changed 5 years ago by refold

I think that this is fixed in HEAD: [3b4ee00e3676c30814cd6ae68275cece0ba60b0d/base]

Last edited 5 years ago by hvr (previous) (diff)

comment:2 Changed 5 years ago by tibbe

Resolution: fixed
Status: newclosed

comment:3 Changed 5 years ago by hvr

Milestone: 7.8.1
Type of failure: None/UnknownDocumentation bug

comment:4 Changed 5 years ago by refold

Component: libraries (other)libraries/base

comment:5 Changed 2 years ago by RyanGlScott

Keywords: Generics added
Note: See TracTickets for help on using tickets.